fwServices::registry::AppConfigParameters Class Reference

This class allows to register all the configuration parameters which has the point extension "::fwServices::registry::AppConfigParameters". More...

#include <AppConfigParameters.hpp>

Inheritance diagram for fwServices::registry::AppConfigParameters:

Collaboration diagram for fwServices::registry::AppConfigParameters:

Public Member Functions
virtual bool	isA (const std::string &type) const override
virtual FWSERVICES_API	~AppConfigParameters ()
	Destructor.
FWSERVICES_API void	parseBundleInformation ()
	Parse bundle information to retrieve config parameters declaration. More...
FWSERVICES_API const FieldAdaptorType &	getParameters (const std::string &extensionId) const
	Get the parameters associated to extension id. More...
FWSERVICES_API void	clearRegistry ()
	Clear the registry. More...
Public Member Functions inherited from fwCore::BaseObject

Static Public Member Functions
static bool	isTypeOf (const std::string &type)
static FWSERVICES_API AppConfigParameters::sptr	getDefault ()
	Return the default global instance of AppConfigParameters.
Static Public Member Functions inherited from fwCore::BaseObject
static bool	isTypeOf (const std::string &type)
static const std::string &	leafClassname ()
	return object's classname without its namespace, i.e. BaseObject
static const std::string &	classname ()
	return object's classname without its namespace, i.e. BaseObject

Protected Types
typedef std::map< std::string, FieldAdaptorType >	Registry

Protected Member Functions
FWSERVICES_API	AppConfigParameters ()
	Constructor.

Protected Attributes
Registry	m_reg
	Container of parameter information.
mutable::fwCore::mt::ReadWriteMutex	m_registryMutex
	Used to protect the registry access.

Static Protected Attributes
static AppConfigParameters::sptr	s_appConfigParameters = AppConfigParameters::New()
	The global instance of the app config parameters.

Friends
template<class , class , class >
class	::fwTools::ClassFactory
class	::fwTools::Factory

Demangling methods
virtual const std::string &	getLeafClassname () const override
	return object's classname without its namespace, i.e. BaseObject
virtual const std::string &	getClassname () const override
	return full object's classname with its namespace, i.e. fwCore::BaseObject
static const std::string &	leafClassname ()
	return object's classname without its namespace, i.e. BaseObject
static const std::string &	classname ()
	return object's classname without its namespace, i.e. BaseObject

Detailed Description

This class allows to register all the configuration parameters which has the point extension "::fwServices::registry::AppConfigParameters".

Definition at line 32 of file AppConfigParameters.hpp.

Member Function Documentation

void fwServices::registry::AppConfigParameters::clearRegistry

(

)

Clear the registry.

Note

This method is thread safe.

Definition at line 77 of file AppConfigParameters.cpp.

References m_reg, and m_registryMutex.

const FieldAdaptorType & fwServices::registry::AppConfigParameters::getParameters

(

const std::string &

extensionId

)

const

Get the parameters associated to extension id.

Note

This method is thread safe.

Definition at line 85 of file AppConfigParameters.cpp.

References m_reg, m_registryMutex, and SLM_ASSERT.

void fwServices::registry::AppConfigParameters::parseBundleInformation

(

)

Parse bundle information to retrieve config parameters declaration.

Warning

This method must be launch only once. The same extension will not be parsed twice.

Note

This method is thread safe.

Definition at line 40 of file AppConfigParameters.cpp.

References m_reg, m_registryMutex, and SLM_ASSERT.

---

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

• AppConfigParameters.hpp
• AppConfigParameters.cpp