An ObjectSnapshot is used to hold the entire state of a data layer’s object, it’s used by object snapshot messages and internally by the data backend.
Methods ¶
Instance Methods ¶
setName(name)
Sets the snapshot object name.
appendPropertyValues(prop_name, values)
Appends values to the property prop_name.
setPropertyValues(prop_name, values)
Replaces property prop_name entries with values.
setPropertyValuesSet(prop_name, values_set)
Replaces property prop_name entries with values_set.
removeProperty(prop_name)
Removes the property prop_name from the object snapshot.
hasProperty(prop_name)
→ bool
Returns true if the object snapshot contains the property prop_name.
getProperty(prop_name)
→ pdgd.ObjectProperty
Returns the property prop_name.
getProperties()
→ dict
Returns a map holding property name and property values entries.
getPropertyKeys()
→ list
of str
Returns a list of available properties in the object snapshot.
toJson()
→ str
Returns a json representation of the object snapshot.
getPythonValue()
→ dict
Returns a generic python types version of the snapshot and its contents.