foundryts.objects.Object

class foundryts.objects.Object(object_type_id)

An object type in the Ontology.

This class provides methods to create references to time series stored as time series properties on objects in the Ontology.

  • Parameters: object_type_id (str) – ID of the object type in the Ontology.
Note

Ensure you’re using the ID for object_type_id since there are three object type references available on the platform: ID, API, RID.

Examples

Copied!
1 2 >>> aircraft_object_type = Object("aircraft") # object type reference >>> airplane = airplane_object_type.id("aircraft-1") # you can now use the primary key to get the object reference

id(object_primary_key_value)

Creates a reference to an Ontology object using its primary key.

  • Parameters: object_primary_key_value (str) – The primary key of the object which can be found either in the dataset defining the object or in the ↗ Object Explorer.
  • Returns: A reference to the Ontology object that can be used to access a time series property using Time Series Property with FoundryObject.property()
  • Return type: FoundryObject

Examples

Copied!
1 2 >>> aircraft_object_type = Object("aircraft") >>> airplane = airplane_object_type.id("aircraft-1") # the object reference can be used for accessing the TSP