Uranium
Application Framework
UM.Settings.Interfaces.ContainerInterface Class Reference

Shared interface between setting container types. More...

Inheritance diagram for UM.Settings.Interfaces.ContainerInterface:
UM.Settings.ContainerStack.ContainerStack UM.Settings.InstanceContainer.InstanceContainer

Public Member Functions

str getId (self)
 Get the ID of the container. More...
 
str getName (self)
 Get the human-readable name of this container. More...
 
Dict[str, Any] getMetaData (self)
 Get all metadata of this container. More...
 
Any getMetaDataEntry (self, str entry, Any default=None)
 Get the value of a single metadata entry. More...
 
Any getProperty (self, str key, str property_name, Optional[PropertyEvaluationContext] context=None)
 Get the value of a property of the container item. More...
 
bool hasProperty (self, str key, str property_name)
 Get whether the container item has a specific property. More...
 
str serialize (self, Optional[set] ignored_metadata_keys=None)
 Serialize this container to a string. More...
 
str deserialize (self, str serialized, Optional[str] file_name=None)
 Deserialize the container from a string representation. More...
 
List[Dict[str, Any]] deserializeMetadata (cls, str serialized, str container_id)
 Deserialize just the metadata from a string representation. More...
 
int getLoadingPriority (cls)
 
Optional[str] getConfigurationTypeFromSerialized (cls, str serialized)
 Gets the configuration type of the given serialized data. More...
 
Optional[int] getVersionFromSerialized (cls, str serialized)
 Gets the version of the given serialized data. More...
 
str getPath (self)
 Get the path used to create this InstanceContainer. More...
 
None setPath (self, str path)
 Set the path used to create this InstanceContainer.
 

Static Public Attributes

 propertyChanged = None
 
 metaDataChanged = None
 

Detailed Description

Shared interface between setting container types.

Member Function Documentation

◆ deserialize()

str UM.Settings.Interfaces.ContainerInterface.deserialize (   self,
str  serialized,
Optional[str]   file_name = None 
)

Deserialize the container from a string representation.

This should replace the contents of this container with those in the serialized representation.

Parameters
serializedA serialized string containing a container that should be deserialized.

Reimplemented in UM.Settings.InstanceContainer.InstanceContainer.

◆ deserializeMetadata()

List[Dict[str, Any]] UM.Settings.Interfaces.ContainerInterface.deserializeMetadata (   cls,
str  serialized,
str  container_id 
)

Deserialize just the metadata from a string representation.

Parameters
serializedA string representing one or more containers that should be deserialized.
container_idThe ID of the (base) container is already known and provided here.
Returns
A list of the metadata of all containers found in the document.

Reimplemented in UM.Settings.InstanceContainer.InstanceContainer, UM.Settings.ContainerStack.ContainerStack, and UM.Settings.DefinitionContainer.DefinitionContainer.

◆ getConfigurationTypeFromSerialized()

Optional[str] UM.Settings.Interfaces.ContainerInterface.getConfigurationTypeFromSerialized (   cls,
str  serialized 
)

Gets the configuration type of the given serialized data.

(used by __updateSerialized())

Reimplemented in UM.Settings.InstanceContainer.InstanceContainer, UM.Settings.ContainerStack.ContainerStack, and UM.Settings.DefinitionContainer.DefinitionContainer.

◆ getId()

str UM.Settings.Interfaces.ContainerInterface.getId (   self)

Get the ID of the container.

The ID should be unique, machine readable and machine writable. It is intended to be used for example when referencing the container in configuration files or when writing a file to disk.

Returns
string The unique ID of this container.

Reimplemented in UM.Settings.InstanceContainer.InstanceContainer, UM.Settings.DefinitionContainer.DefinitionContainer, and UM.Settings.ContainerStack.ContainerStack.

◆ getMetaData()

Dict[str, Any] UM.Settings.Interfaces.ContainerInterface.getMetaData (   self)

Get all metadata of this container.

This returns a dictionary containing all the metadata for this container. How this metadata is used depends on the application.

Returns
dict The metadata for this container.

Reimplemented in UM.Settings.InstanceContainer.InstanceContainer, UM.Settings.DefinitionContainer.DefinitionContainer, and UM.Settings.ContainerStack.ContainerStack.

◆ getMetaDataEntry()

Any UM.Settings.Interfaces.ContainerInterface.getMetaDataEntry (   self,
str  entry,
Any   default = None 
)

Get the value of a single metadata entry.

Parameters
entrystring The key of the metadata to retrieve.
defaultThe default value to return if the entry cannot be found.
Returns
The value of the metadata corresponding to name, or default when the entry could not be found.

◆ getName()

str UM.Settings.Interfaces.ContainerInterface.getName (   self)

Get the human-readable name of this container.

This should return a human-readable name for the container, that can be used in the interface.

Returns
string The name of this container.

Reimplemented in UM.Settings.InstanceContainer.InstanceContainer, UM.Settings.DefinitionContainer.DefinitionContainer, and UM.Settings.ContainerStack.ContainerStack.

◆ getPath()

str UM.Settings.Interfaces.ContainerInterface.getPath (   self)

◆ getProperty()

Any UM.Settings.Interfaces.ContainerInterface.getProperty (   self,
str  key,
str  property_name,
Optional[PropertyEvaluationContext]   context = None 
)

Get the value of a property of the container item.

Parameters
keystring The key of the item to retrieve a property from.
namestring The name of the property to retrieve.
Returns
The specified property value of the container item corresponding to key, or None if not found.

Reimplemented in UM.Settings.ContainerStack.ContainerStack.

◆ getVersionFromSerialized()

Optional[int] UM.Settings.Interfaces.ContainerInterface.getVersionFromSerialized (   cls,
str  serialized 
)

Gets the version of the given serialized data.

(used by __updateSerialized())

Reimplemented in UM.Settings.InstanceContainer.InstanceContainer, UM.Settings.ContainerStack.ContainerStack, and UM.Settings.DefinitionContainer.DefinitionContainer.

◆ hasProperty()

bool UM.Settings.Interfaces.ContainerInterface.hasProperty (   self,
str  key,
str  property_name 
)

Get whether the container item has a specific property.

Parameters
keyThe key of the item to check the property from.
nameThe name of the property to check for.
Returns
True if the specified item has the property, or False if it doesn't.

Reimplemented in UM.Settings.ContainerStack.ContainerStack.

◆ serialize()

str UM.Settings.Interfaces.ContainerInterface.serialize (   self,
Optional[set]   ignored_metadata_keys = None 
)

Serialize this container to a string.

The serialized representation of the container can be used to write the container to disk or send it over the network.

Parameters
ignored_metadata_keysA set of keys that should be ignored when it serializes the metadata.
Returns
string A string representation of this container.

Reimplemented in UM.Settings.InstanceContainer.InstanceContainer, UM.Settings.ContainerStack.ContainerStack, and UM.Settings.DefinitionContainer.DefinitionContainer.


The documentation for this class was generated from the following file: