\r\n

51Degrees Pipeline Python  4.4

51Degrees Pipeline for Python
Search

fiftyone_pipeline_cloudrequestengine.cloudengine.CloudEngine Class Reference

Detailed Description

This is a template for all 51Degrees cloud engines.

It requires the 51Degrees cloudRequestEngine to be placed in a pipeline before it. It takes that raw JSON response and parses it to extract the device part. It also uses this data to generate a list of properties and an evidence key filter

Inheritance diagram for fiftyone_pipeline_cloudrequestengine.cloudengine.CloudEngine:

[legend]

Collaboration diagram for fiftyone_pipeline_cloudrequestengine.cloudengine.CloudEngine:

[legend]

Public Member Functions

def  __init__ (self)
List of Pipelines the FlowElement has been added to. More...
def  on_registration (self, pipeline)
Callback called when an engine is added to a pipeline In this case sets up the properties list for the element from data in the CloudRequestEngine. More...
def  pipeline_element_not_found (self, element, flowdata)
Custom error when an element cannot be found in the pipeline. More...
def  process_internal (self, flowdata)
Process function of a cloud engine. 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  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  get_evidence_key_filter (self)
Filter FlowData evidence using the FlowElement's EvidenceKeyFilter. More...
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 fiftyone_pipeline_cloudrequestengine.cloudengine.CloudEngine.__init__ (   self )

List of Pipelines the FlowElement has been added to.

Reimplemented from fiftyone_pipeline_core.flowelement.FlowElement.

Member Function Documentation

◆ on_registration()

def fiftyone_pipeline_cloudrequestengine.cloudengine.CloudEngine.on_registration (   self,
  pipeline  
)

Callback called when an engine is added to a pipeline In this case sets up the properties list for the element from data in the CloudRequestEngine.

@type pipeline: Pipeline

Parameters
pipeline -

Reimplemented from fiftyone_pipeline_engines.engine.Engine.

◆ pipeline_element_not_found()

def fiftyone_pipeline_cloudrequestengine.cloudengine.CloudEngine.pipeline_element_not_found (   self,
  element,
  flowdata  
)

Custom error when an element cannot be found in the pipeline.

@type element: string

Parameters
element - name of flowelement @type flowdata: flowdata
element - flowdata being processsed @rtype: Exception
Returns
: Returns exception

◆ process_internal()

def fiftyone_pipeline_cloudrequestengine.cloudengine.CloudEngine.process_internal (   self,
  flowdata  
)

Process function of a cloud engine.

This organises and parses data returned from the Cloud Request Engine and adds it to the FlowData

@type flowdata: FlowData

Parameters
flowdata - FlowData to process

Reimplemented from fiftyone_pipeline_core.flowelement.FlowElement.

Member Data Documentation

◆ datakey

fiftyone_pipeline_cloudrequestengine.cloudengine.CloudEngine.datakey

◆ properties

fiftyone_pipeline_cloudrequestengine.cloudengine.CloudEngine.properties
On This Page

Generated by doxygen 1.8.15