\r\n

51Degrees Pipeline Python  4.4

51Degrees Pipeline for Python
Search

tests.test_engines.ExampleAspectEngine Class Reference

Inheritance diagram for tests.test_engines.ExampleAspectEngine:

[legend]

Collaboration diagram for tests.test_engines.ExampleAspectEngine:

[legend]

Public Member Functions

def  __init__ (self)
List of Pipelines the FlowElement has been added to. More...
def  get_evidence_key_filter (self)
Filter FlowData evidence using the FlowElement's EvidenceKeyFilter. More...
def  process_internal (self, flowdata)
The method behind FlowElement.Process - it is called by the process() function. More...

Public Member Functions inherited from fiftyone_pipeline_engines.engine.Engine

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)
Engine's core process function. More...
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 Member Functions inherited from fiftyone_pipeline_core.flowelement.FlowElement

def  filter_evidence (self, flowdata)
Filter FlowData evidence using the FlowElement's EvidenceKeyFilter. More...
def  filter_evidence_key (self, key)
Filter FlowData.evidence using the flowElement's EvidenceKeyFilter with the property key of evidence of interest. More...
def  get_properties (self)
Get the FlowElement.properties of a FlowElement. More...

Public Attributes

 datakey
 properties

Public Attributes inherited from fiftyone_pipeline_engines.engine.Engine

 data_file
 cache
 restricted_properties

Public Attributes inherited from fiftyone_pipeline_core.flowelement.FlowElement

 pipelines  properties  datakey  exclude_from_messages

Constructor & Destructor Documentation

◆ __init__()

def tests.test_engines.ExampleAspectEngine.__init__ (   self )

List of Pipelines the FlowElement has been added to.

Reimplemented from fiftyone_pipeline_core.flowelement.FlowElement.

Member Function Documentation

◆ get_evidence_key_filter()

def 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()

def 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.

Member Data Documentation

◆ datakey

tests.test_engines.ExampleAspectEngine.datakey

◆ properties

tests.test_engines.ExampleAspectEngine.properties
On This Page

Generated by doxygen 1.8.15