ccf::common::ConfigBase Class Reference

Config class for CCF applications. More...

#include <configBase.hpp>

Inheritance diagram for ccf::common::ConfigBase:

Public Member Functions
	~ConfigBase ()
void	Load (const std::string &filename)
	Load the given configuration file. More...
const std::string &	GetFilename () const
	Get the complete name of the configuration file currently loaded. More...
template<class TYPE >
bool	HasPar (const std::string &name, TYPE &value) const
template<class TYPE >
TYPE	GetValue (const std::string &name) const
	Get a parameter value from the configuration. More...
const dit::did::Did &	GetDictionary () const
	Return reference to the Dictionary object in which all Dictionaries specified in cfg are contained. More...
uint32_t	GetMaxFrameSize ()
	Return the maximum frame size in bytes with the associated camera/configuration. More...
virtual uint32_t	GetMaxFrameSizeUser ()
template<class TYPE >
bool	HasAdapterProperty (const std::string &property, TYPE &value)
Public Member Functions inherited from ccf::common::Base
	Base ()
	~Base ()
const std::string &	GetClassName () const
	Return the allocated name of the class. More...

Static Public Member Functions
static ConfigBase &	Instance ()
	Return reference to unique instance of the configuration class. More...
Static Public Member Functions inherited from ccf::common::Base
static ccf::mptk::Manager &	Mptk ()
	Return reference to internal MPTK instance (singleton). More...
static void	SetLogLevel (const ccf::common::LogLevel log_level)
	Set the log level. More...
static ccf::common::LogLevel	GetLogLevel ()
	Return the current CCF log level. More...

Static Public Attributes
static ConfigBase *	s_instance = NULL

Protected Member Functions
bool	_HasAdapterProperty (const std::string &property, std::string &value)
Protected Member Functions inherited from ccf::common::Base
void	SetClassName (const std::string &class_name)
	Set the name of the class in question. More...

Detailed Description

Config class for CCF applications.

The class is used as a Singleton, whereby the instance is retrieved with "Instance()".

Constructor & Destructor Documentation

~ConfigBase()

ccf::common::ConfigBase::~ConfigBase

(

)

Member Function Documentation

_HasAdapterProperty()

bool ccf::common::ConfigBase::_HasAdapterProperty ( const std::string &  property, std::string &  value  )

protected

GetDictionary()

const dit::did::Did & ccf::common::ConfigBase::GetDictionary

(

)

const

Return reference to the Dictionary object in which all Dictionaries specified in cfg are contained.

GetFilename()

const std::string & ccf::common::ConfigBase::GetFilename

(

)

const

Get the complete name of the configuration file currently loaded.

GetMaxFrameSize()

uint32_t ccf::common::ConfigBase::GetMaxFrameSize

(

)

Return the maximum frame size in bytes with the associated camera/configuration.

GetMaxFrameSizeUser()

uint32_t ccf::common::ConfigBase::GetMaxFrameSizeUser ( )

virtual

Specific implementation of the algorithm to derive the maximum frame size. Need normally not be implemented by the user.

GetValue()

template<class TYPE >

TYPE ccf::common::ConfigBase::GetValue ( const std::string &  name ) const

inline

Get a parameter value from the configuration.

HasAdapterProperty()

template<class TYPE >

bool ccf::common::ConfigBase::HasAdapterProperty ( const std::string &  property, TYPE &  value  )

inline

Check if the given Communication Adapter Property is defined in the configuration, return true if yes, and the value in the "value" parameter.

HasPar()

template<class TYPE >

bool ccf::common::ConfigBase::HasPar ( const std::string &  name, TYPE &  value  ) const

inline

Probe if a given parameter is defined in the set. Return true if yes and set the value to the value of the parameter.

Instance()

ConfigBase & ccf::common::ConfigBase::Instance ( )

static

Return reference to unique instance of the configuration class.

Load()

void ccf::common::ConfigBase::Load

(

const std::string &

filename

)

Load the given configuration file.

Member Data Documentation

s_instance

ConfigBase * ccf::common::ConfigBase::s_instance = NULL

static

---

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

• common/src/include/ccf/common/configBase.hpp
• common/src/configBase.cpp