◆ __init__()
| def pipeline-python.fiftyone_pipeline_engines.fiftyone_pipeline_engines.engine.Engine.__init__ | ( | self, | |
data_file = None
|
|||
| ) |
Constructor for an engine.
Detailed Description
An engine is an extension of the FlowElement class that adds extra functionality.
Inheritance diagram for pipeline-python.fiftyone_pipeline_engines.fiftyone_pipeline_engines.engine.Engine:
Collaboration diagram for pipeline-python.fiftyone_pipeline_engines.fiftyone_pipeline_engines.engine.Engine:
Public Member Functions
| def | __init__ (self, data_file=None)
Constructor for an engine. More...
|
| def | set_cache (self, cache)
Add a cache to an engine @type cashe: Cache. More...
|
| def | set_restricted_properties (self, properties_list)
Add a subset of properties. More...
|
| def | in_cache (self, flowdata)
A method to check if a flowdata's evidence is in the cache. More...
|
| def | refresh (self, identifier) |
| def | process (self, flowdata) |
| def | 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. More...
|
| def | register_data_file (self, data_file)
Register a data_file of the DataFile class with the engine @type data_file: DataFile. More...
|
Public Attributes
Constructor & Destructor Documentation
Member Function Documentation
◆ in_cache()
| def pipeline-python.fiftyone_pipeline_engines.fiftyone_pipeline_engines.engine.Engine.in_cache | ( | self, | |
| flowdata | |||
| ) |
A method to check if a flowdata's evidence is in the cache.
@type FlowData: FlowData
- Parameters
-
- FlowData - @rtype: bool
- Returns
- : True or false: a flowdata's evidence is in the cache
◆ on_registration()
def pipeline-python.fiftyone_pipeline_engines.fiftyone_pipeline_engines.engine.Engine.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.
@type pipeline: Pipeline
- Parameters
-
- pipeline - The pipeline the engine has been attached to
◆ process()
def pipeline-python.fiftyone_pipeline_engines.fiftyone_pipeline_engines.engine.Engine.process ( self, flowdata ) Engine's core process function.
Calls specific overriden processInternal methods but wraps it in a cache check and a cache put
@type flowdata: FlowData
- Parameters
-
- flowdata -
◆ register_data_file()
def pipeline-python.fiftyone_pipeline_engines.fiftyone_pipeline_engines.engine.Engine.register_data_file ( self, data_file ) Register a data_file of the DataFile class with the engine @type data_file: DataFile.
- Parameters
-
- data_file - DataFile (such as for an on premise engine)
◆ set_cache()
def pipeline-python.fiftyone_pipeline_engines.fiftyone_pipeline_engines.engine.Engine.set_cache ( self, cache ) Add a cache to an engine @type cashe: Cache.
- Parameters
-
- cache - Cache with get and set methods
◆ set_restricted_properties()
def pipeline-python.fiftyone_pipeline_engines.fiftyone_pipeline_engines.engine.Engine.set_restricted_properties ( self, properties_list ) Add a subset of properties.
@type properties_list: string[]
- Parameters
-
- properties_list - An array of properties to include