PropertySet

PropertySets	Collection of property-sets
PropertySet	Class aggregating a time domain, space domain, and properties of a set of objects

class lue.data_model.PropertySets

Collection of property-sets

Property-set collections can be obtained from Phenomenon instances.

class lue.data_model.PropertySet

Class aggregating a time domain, space domain, and properties of a set of objects

The information stored in a property-set is a consistant whole. In case a time domain is present, and a space domain is present and one or more properties are present, then for each location in time and for each active object, a location in space is stored, and for each property a value is stored.

Which objects are active at each location in time is tracked by the object_tracker.

add_property(*args, **kwargs)

Overloaded function.

1. add_property(self: lue.lue_py.data_model.PropertySet, name: str, dtype: object, description: str = ‘’) -> lue.lue_py.data_model.same_shape.Property

   Add new property to collection

   param str name:

   Name of property to create

   param dtype numpy.dtype:

   Datatype of object array elements

   param str description:

   Description

   return:

   Property created

   rtype:

   same_shape.Property

   raises RuntimeError:

   In case the property cannot be created

2. add_property(self: lue.lue_py.data_model.PropertySet, name: str, dtype: object, shape: tuple, description: str = ‘’) -> lue.lue_py.data_model.same_shape.Property

   Add new property to collection

   param str name:

   Name of property to create

   param dtype numpy.dtype:

   Datatype of object array elements

   param tuple shape:

   Shape of object arrays

   param str description:

   Description

   return:

   Property created

   rtype:

   same_shape.Property

   raises RuntimeError:

   In case the property cannot be created

3. add_property(self: lue.lue_py.data_model.PropertySet, name: str, dtype: object, shape: tuple, value_variability: lue.lue_py.data_model.ValueVariability, description: str = ‘’) -> object

   Add new property to collection

   param str name:

   Name of property to create

   param dtype numpy.dtype:

   Datatype of object array elements

   param tuple shape:

   Shape of object arrays

   param ValueVariability value_variability:

   Value variability

   param str description:

   Description

   return:

   Property created

   rtype:

   same_shape.Property or lue.same_shape.constant_shape.Property, depending on the value_variability passed in

   raises RuntimeError:

   In case the property cannot be created

4. add_property(self: lue.lue_py.data_model.PropertySet, name: str, dtype: object, rank: int, description: str = ‘’) -> lue.lue_py.data_model.different_shape.Property

   Add new property to collection

   param str name:

   Name of property to create

   param dtype numpy.dtype:

   Datatype of object array elements

   param int rank:

   Rank of object arrays

   param str description:

   Description

   return:

   Property created

   rtype:

   different_shape.Property

   raises RuntimeError:

   In case the property cannot be created

5. add_property(self: lue.lue_py.data_model.PropertySet, name: str, dtype: object, rank: int, shape_per_object: lue.lue_py.data_model.ShapePerObject, shape_variability: lue.lue_py.data_model.ShapeVariability, description: str = ‘’) -> object

   Add new property to collection

   param str name:

   Name of property to create

   param dtype numpy.dtype:

   Datatype of object array elements

   param int rank:

   Rank of object arrays

   param ShapePerObject shape_per_object:

   Shape per object

   param ShapeVariability shape_variability:

   Shape variability

   param str description:

   Description

   return:

   Property created

   rtype:

   same_shape::variable_shape::Property, different_shape::constant_shape::Property or different_shape::variable_shape::Property depending on shape_per_object and shape_variability passed in

   raises RuntimeError:

   In case the property cannot be created

property has_space_domain

Return whether the property-set has a space domain

property has_time_domain

Return whether the property-set has a time domain

property object_tracker

Return the active objects tracker

Return type:

ObjectTracker

property properties

TODO docstring

property space_domain

Return the space domain

Return type:

SpaceDomain

Raises:

RuntimeError – In case the property-set does not have a space domain

property time_domain

Return the time domain

Return type:

TimeDomain

Raises:

RuntimeError – In case the property-set does not have a time domain