Inheritance diagram for tests.test_engines.ExampleAspectEngine:
Collaboration diagram for tests.test_engines.ExampleAspectEngine:
Public Member Functions | |
| __init__ (self) | |
| get_evidence_key_filter (self) | |
| Filter FlowData evidence using the FlowElement's EvidenceKeyFilter. | |
| process_internal (self, flowdata) | |
| The method behind FlowElement.Process - it is called by the process() function. | |
Public Member Functions inherited from fiftyone_pipeline_engines.engine.Engine | |
| __init__ (self, data_file=None) | |
| Constructor for an engine. | |
| set_cache (self, cache) | |
| Add a cache to an engine @type cashe: Cache. | |
| set_restricted_properties (self, properties_list) | |
| Add a subset of properties. | |
| in_cache (self, flowdata) | |
| A method to check if a flowdata's evidence is in the cache. | |
| refresh (self, identifier) | |
| process (self, flowdata) | |
| Engine's core process function. | |
| on_registration (self, pipeline) | |
| Called when an engine is registered with a pipeline and if there is a data file, a data file update service is attached to the parent pipeline. | |
| close (self) | |
| Stop the checks and updates of the engine's data file, whose timers would otherwise keep the engine alive. | |
| register_data_file (self, data_file) | |
| Register a data_file of the DataFile class with the engine @type data_file: DataFile. | |
Public Member Functions inherited from fiftyone_pipeline_core.flowelement.FlowElement | |
| __init__ (self) | |
| List of Pipelines the FlowElement has been added to. | |
| filter_evidence (self, flowdata) | |
| Filter FlowData evidence using the FlowElement's EvidenceKeyFilter. | |
| filter_evidence_key (self, key) | |
| Filter FlowData.evidence using the flowElement's EvidenceKeyFilter with the property key of evidence of interest. | |
| get_properties (self) | |
| Get the FlowElement.properties of a FlowElement. | |
Additional Inherited Members | |
Public Attributes inherited from fiftyone_pipeline_engines.engine.Engine | |
| data_file = data_file | |
| cache = cache | |
| restricted_properties = properties_list | |
Public Attributes inherited from fiftyone_pipeline_core.flowelement.FlowElement | |
| list | pipelines = [] |
| dict | properties = {} |
| str | datakey = "" |
| bool | exclude_from_messages = False |
Protected Member Functions inherited from fiftyone_pipeline_core.flowelement.FlowElement | |
| _log (self, level, message) | |
Constructor & Destructor Documentation
◆ __init__()
| tests.test_engines.ExampleAspectEngine.__init__ | ( | self | ) |
Member Function Documentation
◆ get_evidence_key_filter()
| tests.test_engines.ExampleAspectEngine.get_evidence_key_filter | ( | self | ) |
Filter FlowData evidence using the FlowElement's EvidenceKeyFilter.
@rtype: EvidenceKeyFilter
- Returns
- : Returns an EvidenceKeyFilter
Reimplemented from fiftyone_pipeline_core.flowelement.FlowElement.
◆ process_internal()
| tests.test_engines.ExampleAspectEngine.process_internal | ( | self, | |
| flowdata ) |
The method behind FlowElement.Process - it is called by the process() function.
It is usually overridden by specific flowElements to do their core work.
@type flowdata: FlowData
- Parameters
-
flowdata FlowData to be processed
@rtype: bool
- Returns
- : Returns True
Reimplemented from fiftyone_pipeline_core.flowelement.FlowElement.