Uranium
Application Framework
|
Shared interface between setting container types. More...
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 | |
Shared interface between setting container types.
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.
serialized | A serialized string containing a container that should be deserialized. |
Reimplemented in UM.Settings.InstanceContainer.InstanceContainer.
List[Dict[str, Any]] UM.Settings.Interfaces.ContainerInterface.deserializeMetadata | ( | cls, | |
str | serialized, | ||
str | container_id | ||
) |
Deserialize just the metadata from a string representation.
serialized | A string representing one or more containers that should be deserialized. |
container_id | The ID of the (base) container is already known and provided here. |
Reimplemented in UM.Settings.InstanceContainer.InstanceContainer, UM.Settings.ContainerStack.ContainerStack, and UM.Settings.DefinitionContainer.DefinitionContainer.
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.
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.
Reimplemented in UM.Settings.InstanceContainer.InstanceContainer, UM.Settings.DefinitionContainer.DefinitionContainer, and UM.Settings.ContainerStack.ContainerStack.
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.
Reimplemented in UM.Settings.InstanceContainer.InstanceContainer, UM.Settings.DefinitionContainer.DefinitionContainer, and UM.Settings.ContainerStack.ContainerStack.
Any UM.Settings.Interfaces.ContainerInterface.getMetaDataEntry | ( | self, | |
str | entry, | ||
Any | default = None |
||
) |
Get the value of a single metadata entry.
entry | string The key of the metadata to retrieve. |
default | The default value to return if the entry cannot be found. |
name
, or default
when the entry could not be found. 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.
Reimplemented in UM.Settings.InstanceContainer.InstanceContainer, UM.Settings.DefinitionContainer.DefinitionContainer, and UM.Settings.ContainerStack.ContainerStack.
str UM.Settings.Interfaces.ContainerInterface.getPath | ( | self | ) |
Get the path used to create this InstanceContainer.
Reimplemented in UM.Settings.ContainerStack.ContainerStack, UM.Settings.InstanceContainer.InstanceContainer, and UM.Settings.DefinitionContainer.DefinitionContainer.
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.
key | string The key of the item to retrieve a property from. |
name | string The name of the property to retrieve. |
Reimplemented in UM.Settings.ContainerStack.ContainerStack.
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.
bool UM.Settings.Interfaces.ContainerInterface.hasProperty | ( | self, | |
str | key, | ||
str | property_name | ||
) |
Get whether the container item has a specific property.
key | The key of the item to check the property from. |
name | The name of the property to check for. |
Reimplemented in UM.Settings.ContainerStack.ContainerStack.
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.
ignored_metadata_keys | A set of keys that should be ignored when it serializes the metadata. |
Reimplemented in UM.Settings.InstanceContainer.InstanceContainer, UM.Settings.ContainerStack.ContainerStack, and UM.Settings.DefinitionContainer.DefinitionContainer.