Inheritance diagram for fiftyone\pipeline\devicedetection\DeviceDetectionOnPremise:
Collaboration diagram for fiftyone\pipeline\devicedetection\DeviceDetectionOnPremise:
Public Member Functions | |
| __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. | |
| getEvidenceKeyFilter () | |
| Instance of EvidenceKeyFilter based on the evidence keys fetched from the cloud service by the private getEvidenceKeys() method. | |
| processInternal (FlowData $flowData) | |
| Process FlowData - this is process function is usually overridden by specific FlowElements to do their core work. | |
| setCache (?DataKeyedCache $cache) | |
| Add a cache to an engine. | |
| refreshData (?string $fileName_or_data=null, ?int $length=null) | |
| Ask the engine to start using the specified data file for detections. | |
Public Member Functions inherited from fiftyone\pipeline\engines\Engine | |
| getDataSourceTier () | |
| Get the tier to which the current data source belongs. | |
| setCache (DataKeyedCache $cache) | |
| Add a cache to an engine. | |
| setRestrictedProperties (array $propertiesList) | |
| Add a subset of properties. | |
| inCache (FlowData $flowData) | |
| A method to check if a flowData's evidence is in the cache. | |
| process (FlowData $flowData) | |
| Engine's core process function. | |
Public Member Functions inherited from fiftyone\pipeline\core\FlowElement | |
| 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 = 'device' |
| EngineHashSwig | $engine |
Data Fields inherited from fiftyone\pipeline\engines\Engine | |
| array | $restrictedProperties |
Data Fields inherited from fiftyone\pipeline\core\FlowElement | |
| string | $dataKey |
| array | $properties = [] |
| array | $pipelines = [] |
Constructor & Destructor Documentation
◆ __construct()
| fiftyone\pipeline\devicedetection\DeviceDetectionOnPremise::__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.
Unfortunately intermediates do not define their own __construct() so the call propagates up to the base class FlowElement and fails. Intermediates might define their own __construct() at some point, so we do not want to remove parent::__construct() calls, rather add this one as a catch-all.
Reimplemented from fiftyone\pipeline\core\FlowElement.
Member Function Documentation
◆ getEvidenceKeyFilter()
| fiftyone\pipeline\devicedetection\DeviceDetectionOnPremise::getEvidenceKeyFilter | ( | ) |
Instance of EvidenceKeyFilter based on the evidence keys fetched from the cloud service by the private getEvidenceKeys() method.
Reimplemented from fiftyone\pipeline\core\FlowElement.
◆ processInternal()
| fiftyone\pipeline\devicedetection\DeviceDetectionOnPremise::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.
◆ refreshData()
| fiftyone\pipeline\devicedetection\DeviceDetectionOnPremise::refreshData | ( | ?string | $fileName_or_data = null, |
| ?int | $length = null ) |
Ask the engine to start using the specified data file for detections.
This can be used in 3 different scenarios:
- The data file that was originally used to create the engine has been updated on disk. In this case, no parameters are needed.
- A new data file is available, but it is in a different location to the original. In this case, the parameter should be the new data file location.
- A new data file is available in memory. The first parameter will be the variable holding the in-memory data file. The second will be the size of the data file in bytes.
- Parameters
-
null | string $fileName_or_data Data file path or the variable holding the in-memory data file null | int $length Length of the in-memory data file in bytes
◆ setCache()
| fiftyone\pipeline\devicedetection\DeviceDetectionOnPremise::setCache | ( | ?DataKeyedCache | $cache | ) |
Add a cache to an engine.
- Parameters
-
null | \fiftyone\pipeline\engines\DataKeyedCache $cache Cache with get and set methods
- Exceptions
-
Exception