VisionWorks Toolkit Reference

December 18, 2015 | 1.2 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
nvxio::ConfigParser Class Referenceabstract

Detailed Description

ConfigParser interface.

See also
NVXIO APIs

Definition at line 67 of file ConfigParser.hpp.

Public Member Functions

virtual void addParameter (const std::string &paramName, OptionHandler::ptr handler)=0
 Adds a parameter that should be read. More...
 
virtual std::string parse (const std::string &pathToConfigFile)=0
 Parses the configuration file and fills the parameters with the corresponding values from the configuration file. More...
 
virtual ~ConfigParser ()
 Destructor. More...
 

Constructor & Destructor Documentation

virtual nvxio::ConfigParser::~ConfigParser ( )
inlinevirtual

Destructor.

Definition at line 73 of file ConfigParser.hpp.

Member Function Documentation

virtual void nvxio::ConfigParser::addParameter ( const std::string &  paramName,
OptionHandler::ptr  handler 
)
pure virtual

Adds a parameter that should be read.

Parameters
[in]paramNameA reference to the name of the parameter.
[in]handlerOptionHandler that will be used to process the parameter.
virtual std::string nvxio::ConfigParser::parse ( const std::string &  pathToConfigFile)
pure virtual

Parses the configuration file and fills the parameters with the corresponding values from the configuration file.

Precondition
Parameters to be filled have been added using the ConfigParser::addParameter method.
Parameters
[in]pathToConfigFileA reference to the path to the configuration file.
Returns
Error message or the empty string if the operation has succeeded.

The documentation for this class was generated from the following file: