Inheritance diagram for ExampleFlowElementA:
Collaboration diagram for ExampleFlowElementA:
Public Member Functions | |
| processInternal (FlowData $flowData) | |
| Process FlowData - this is process function is usually overridden by specific FlowElements to do their core work. | |
| getEvidenceKeyFilter () | |
| Function for getting the FlowElement's EvidenceKeyFilter Used by the filterEvidence method. | |
Public Member Functions inherited from fiftyone\pipeline\core\FlowElement | |
| __construct () | |
| A default dummy constructor is needed for there are classes inheriting this class deeper than 1-level of inheritance and calling parent::__construct() in their explicit constructors. | |
| process (FlowData $flowData) | |
| General wrapper function that calls a FlowElement's processInternal method. | |
| filterEvidence (FlowData $flowData) | |
| Filter FlowData evidence using the FlowElement's EvidenceKeyFilter. | |
| filterEvidenceKey (string $key) | |
| Filter FlowData evidence using the FlowElement's EvidenceKeyFilter. | |
| onRegistration (Pipeline $pipeline) | |
| Callback called when an engine is added to a pipeline. | |
| getProperties () | |
| Get properties Usually overridden by specific FlowElements. | |
| updatePropertyList () | |
| Update a FlowElement's property list This is used by elements that are only aware of their properties at a later stage, such as cloud request based FlowElements or FlowElements that change their properties later based on new datafiles. | |
Data Fields | |
| string | $dataKey = 'example1' |
| array | $properties |
Data Fields inherited from fiftyone\pipeline\core\FlowElement | |
| string | $dataKey |
| array | $properties = [] |
| array | $pipelines = [] |
Member Function Documentation
◆ getEvidenceKeyFilter()
| ExampleFlowElementA::getEvidenceKeyFilter | ( | ) |
Function for getting the FlowElement's EvidenceKeyFilter Used by the filterEvidence method.
Reimplemented from fiftyone\pipeline\core\FlowElement.
◆ processInternal()
| ExampleFlowElementA::processInternal | ( | FlowData | $flowData | ) |
Process FlowData - this is process function is usually overridden by specific FlowElements to do their core work.
Reimplemented from fiftyone\pipeline\core\FlowElement.
Field Documentation
◆ $properties
| array ExampleFlowElementA::$properties |
Initial value:
= [
'exampleProperty1' => [
'type' => 'int'
]
]