DFX Extraction library v4.12.0
enabling applications to perform DFX blood flow analysis
DFXFactory.h
1  /*
2  * Copyright (c) 2016-2019, Nuralogix Corp.
3  * All Rights reserved
4  *
5  * THIS SOFTWARE IS LICENSED BY AND IS THE CONFIDENTIAL AND
6  * PROPRIETARY PROPERTY OF NURALOGIX CORP. IT IS
7  * PROTECTED UNDER THE COPYRIGHT LAWS OF THE USA, CANADA
8  * AND OTHER FOREIGN COUNTRIES. THIS SOFTWARE OR ANY
9  * PART THEREOF, SHALL NOT, WITHOUT THE PRIOR WRITTEN CONSENT
10  * OF NURALOGIX CORP, BE USED, COPIED, DISCLOSED,
11  * DECOMPILED, DISASSEMBLED, MODIFIED OR OTHERWISE TRANSFERRED
12  * EXCEPT IN ACCORDANCE WITH THE TERMS AND CONDITIONS OF A
13  * NURALOGIX CORP SOFTWARE LICENSE AGREEMENT.
14  */
15 #pragma once
16 #ifndef LIBDFX_FACTORY_H
17 #define LIBDFX_FACTORY_H
18 
19 #include <map>
20 #include <memory>
21 #include <string>
22 
23 #include "dfx/Collector.h"
24 
25 namespace dfx {
114 class DFXFactory {
115  public:
119  virtual ~DFXFactory() {
120  // Empty but necessary for vtable
121  }
122 
128  virtual std::string getVersion() const = 0;
129 
139  virtual std::string getSdkID() const = 0;
140 
152  virtual bool setMode(const std::string& mode) = 0;
153 
160  virtual std::string getMode() const = 0;
161 
168  virtual std::string getLastErrorMessage() = 0;
169 
179  virtual void setProperty(const std::string &key, const std::string &value) = 0;
180 
187  virtual std::string getProperty(const std::string &key) = 0;
188 
196  virtual void removeProperty(const std::string &key) = 0;
197 
205  virtual std::vector<std::string> getValidProperties() const = 0;
206 
222  virtual bool initializeStudy(const std::vector<unsigned char> &data) = 0;
223 
242  virtual bool addToStudy(const std::vector<unsigned char> &data) = 0;
243 
263  virtual bool initializeStudyFromFile(const std::string &pathToFile) = 0;
264 
283  virtual bool addToStudyFromFile(const std::string &pathToFile) = 0;
284 
291  virtual std::shared_ptr<dfx::Collector> createCollector() = 0;
292 };
293 } // namespace dfx
294 
295 #endif // LIBDFX_FACTORY_H
dfx::DFXFactory::addToStudy
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...
dfx::DFXFactory::getProperty
virtual std::string getProperty(const std::string &key)=0
Returns a property value for a key.
dfx::DFXFactory::removeProperty
virtual void removeProperty(const std::string &key)=0
Removes a property from the factory if it exists.
dfx::DFXFactory::getSdkID
virtual std::string getSdkID() const =0
The ID of this DFX Extraction library.
dfx::DFXFactory::getVersion
virtual std::string getVersion() const =0
The version ID of this DFX Extraction library.
dfx::DFXFactory::getLastErrorMessage
virtual std::string getLastErrorMessage()=0
If there was an error getLastErrorMessage may contain more information about why the erorr occurred.
dfx::DFXFactory::getMode
virtual std::string getMode() const =0
Returns the current operating mode when creating collectors.
dfx::DFXFactory::addToStudyFromFile
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...
dfx::DFXFactory::initializeStudyFromFile
virtual bool initializeStudyFromFile(const std::string &pathToFile)=0
Initializes the factory to create collectors for a study with a file based data definition.
dfx::DFXFactory
DFXFactory is the primary entry point for the collector and is used create a collector.
Definition: DFXFactory.h:114
dfx::DFXFactory::createCollector
virtual std::shared_ptr< dfx::Collector > createCollector()=0
Creates a Collector to process video frames and build a request payload.
dfx::DFXFactory::getValidProperties
virtual std::vector< std::string > getValidProperties() const =0
Obtain a list of valid property keys which can be configured.
dfx::DFXFactory::~DFXFactory
virtual ~DFXFactory()
DFXFactory destructor.
Definition: DFXFactory.h:119
dfx::DFXFactory::setMode
virtual bool setMode(const std::string &mode)=0
Set the operating mode which will be used when creating a new collector.
dfx
Definition: ChunkData.h:21
dfx::DFXFactory::initializeStudy
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.
dfx::DFXFactory::setProperty
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.