|
DFX Extraction library v4.14.5
enabling applications to perform DFX blood flow analysis
|
16 #ifndef LIBDFX_FACTORY_H
17 #define LIBDFX_FACTORY_H
23 #include "dfx/Collector.h"
139 virtual std::string
getSdkID()
const = 0;
152 virtual bool setMode(
const std::string& mode) = 0;
160 virtual std::string
getMode()
const = 0;
179 virtual void setProperty(
const std::string &key,
const std::string &value) = 0;
187 virtual std::string
getProperty(
const std::string &key) = 0;
222 virtual bool initializeStudy(
const std::vector<unsigned char> &data) = 0;
242 virtual bool addToStudy(
const std::vector<unsigned char> &data) = 0;
295 #endif // LIBDFX_FACTORY_H
virtual bool addToStudy(const std::vector< unsigned char > &data)=0
Adds to the study definition when a definition is comprised of multiple parts with an additional memo...
virtual std::string getProperty(const std::string &key)=0
Returns a property value for a key.
virtual void removeProperty(const std::string &key)=0
Removes a property from the factory if it exists.
virtual std::string getSdkID() const =0
The ID of this DFX Extraction library.
virtual std::string getVersion() const =0
The version ID of this DFX Extraction library.
virtual std::string getLastErrorMessage()=0
If there was an error getLastErrorMessage may contain more information about why the erorr occurred.
virtual std::string getMode() const =0
Returns the current operating mode when creating collectors.
virtual bool addToStudyFromFile(const std::string &pathToFile)=0
Adds to the study definition when a definition is comprised of multiple parts with an additional file...
virtual bool initializeStudyFromFile(const std::string &pathToFile)=0
Initializes the factory to create collectors for a study with a file based data definition.
DFXFactory is the primary entry point for the collector and is used create a collector.
Definition: DFXFactory.h:114
virtual std::shared_ptr< dfx::Collector > createCollector()=0
Creates a Collector to process video frames and build a request payload.
virtual std::vector< std::string > getValidProperties() const =0
Obtain a list of valid property keys which can be configured.
virtual ~DFXFactory()
DFXFactory destructor.
Definition: DFXFactory.h:119
virtual bool setMode(const std::string &mode)=0
Set the operating mode which will be used when creating a new collector.
Definition: ChunkData.h:21
virtual bool initializeStudy(const std::vector< unsigned char > &data)=0
Initializes the factory to create collectors for a study with a memory based data definition.
virtual void setProperty(const std::string &key, const std::string &value)=0
Specifies a configurable property key/value pair to configure the DFX Extraction library.