Detailed Description
Core ElementData class Stores information created by a FlowElement based on FlowData.
Stored in FlowData
Inheritance diagram for fiftyone_pipeline_core.elementdata.ElementData:
Collaboration diagram for fiftyone_pipeline_core.elementdata.ElementData:
Public Member Functions | |
| __init__ (self, flow_element) | |
| Constructor for ElementData. | |
| get (self, key) | |
| Get a value from the elementData contents Proxy for the ElementData.getInternal method. | |
| __getattr__ (self, key) | |
| Magic getter for a property from the data Allowing user to write for example Data.IsMobile rather than Data.get("IsMobile). | |
| __getitem__ (self, flow_element_key) | |
| Magic method in Python, which when used in a class, allows its instances to use the [] (indexer) operators. | |
| get_internal (self, key) | |
| Returns the requested property from the data Overridden by specific ElementData instances. | |
| get_properties (self) | |
| Proxy to the data's flowElement properties. | |
Public Attributes | |
| flow_element = flow_element | |
Constructor & Destructor Documentation
◆ __init__()
| fiftyone_pipeline_core.elementdata.ElementData.__init__ | ( | self, | |
| flow_element ) |
Constructor for ElementData.
@type flow_element: FlowElement
- Parameters
-
flow_element FlowElement that data has been created by
Member Function Documentation
◆ __getattr__()
| fiftyone_pipeline_core.elementdata.ElementData.__getattr__ | ( | self, | |
| key ) |
Magic getter for a property from the data Allowing user to write for example Data.IsMobile rather than Data.get("IsMobile).
@type key: str
- Parameters
-
key property
@rtype: mixed
- Returns
- : Returns specified property from the data
◆ __getitem__()
| fiftyone_pipeline_core.elementdata.ElementData.__getitem__ | ( | self, | |
| flow_element_key ) |
Magic method in Python, which when used in a class, allows its instances to use the [] (indexer) operators.
For example, instead of flowdata.get("device") you can use flowdata["device"]
@type flow_element_key: string
- Parameters
-
flow_element_key datakey of the FlowElement that created the data of interest
@rtype: ElementData
◆ get()
| fiftyone_pipeline_core.elementdata.ElementData.get | ( | self, | |
| key ) |
Get a value from the elementData contents Proxy for the ElementData.getInternal method.
@type key: str
- Parameters
-
key
@rtype: mixed
- Returns
- : Returns specified property from the data
Reimplemented in fiftyone_pipeline_engines.aspectdata.AspectData.
◆ get_internal()
| fiftyone_pipeline_core.elementdata.ElementData.get_internal | ( | self, | |
| key ) |
Returns the requested property from the data Overridden by specific ElementData instances.
@type key: str
- Parameters
-
key property
@rtype: mixed
- Returns
- : Returns Requested property from data
Reimplemented in fiftyone_pipeline_core.elementdata_dictionary.ElementDataDictionary, and fiftyone_pipeline_engines.aspectdata_dictionary.AspectDataDictionary.
◆ get_properties()
| fiftyone_pipeline_core.elementdata.ElementData.get_properties | ( | self | ) |
Proxy to the data's flowElement properties.
Gets the FlowElement.properties of the parent FlowElement.
@rtype: DataPropertyDictionary
- Returns
- : Returns dictionary of the parent FlowElement's properties
Member Data Documentation
◆ flow_element
| fiftyone_pipeline_core.elementdata.ElementData.flow_element = flow_element |