Editable configuration element : allow the self configuration element building, which reading XML structure provided by bundle descriptions. More...

#include <EConfigurationElement.hpp>

Inheritance diagram for fwRuntime::EConfigurationElement:

Collaboration diagram for fwRuntime::EConfigurationElement:

Public Member Functions
virtual bool	isA (const std::string &type) const override

FWRUNTIME_API	EConfigurationElement (const std::string &name)
	Constructor. More...

virtual FWRUNTIME_API	~EConfigurationElement ()
	Destructor : does nothing.

FWRUNTIME_API EConfigurationElement::sptr	addConfigurationElement (const std::string &name)
	Create and add a configuration element. More...

FWRUNTIME_API void	addConfigurationElement (EConfigurationElement::sptr element)
	Adds a new configuration element to the extension. More...

FWRUNTIME_API void	setAttributeValue (const std::string &name, const std::string &value) noexcept

FWRUNTIME_API void	setValue (const std::string &value) noexcept

Public Member Functions inherited from fwRuntime::ConfigurationElement
FWRUNTIME_API const std::shared_ptr< Bundle >	getBundle () const noexcept
	Retrieves the bundle the configuration element is attached to. More...

FWRUNTIME_API const std::string	getAttributeValue (const std::string &name) const noexcept
	Retrieves the value of an attribute for the specified name. More...

FWRUNTIME_API const std::string	getExistingAttributeValue (const std::string &name) const
	Retrieves the value of an attribute for the specified name. More...

FWRUNTIME_API const AttributePair	getSafeAttributeValue (const std::string &name) const noexcept
	Retrieves the value of an existing attribute for the specified name. More...

FWRUNTIME_API const std::string	getName () const noexcept
	Retrieves the name of the configuration element. More...

FWRUNTIME_API const std::string	getValue () const noexcept
	Retrieves the configuration element value. More...

FWRUNTIME_API bool	hasAttribute (const std::string &name) const noexcept
	Tells if the specified attributes exists. More...

FWRUNTIME_API const std::map< std::string, std::string >	getAttributes () const noexcept
	Return the map with attributes.

FWRUNTIME_API std::vector< ConfigurationElement::sptr >	find (std::string name="", std::string attribute="", std::string attributeValue="", int depth=1)
	Find recursively all the corresponding configuration elements. More...

virtual FWRUNTIME_API	~ConfigurationElement ()
	Used only because this class inherit from enable_shared_from_this.

Public Member Functions inherited from fwRuntime::ConfigurationElementContainer
FWRUNTIME_API Iterator	begin ()
	Retrieves the iterator on the first managed configuration element. More...

FWRUNTIME_API Iterator	end ()
	Retrieves the iterator on the end of the configuration element container. More...

FWRUNTIME_API const Container &	getElements () const
	Returns the configuration element container. More...

FWRUNTIME_API const std::shared_ptr< ConfigurationElement >	findConfigurationElement (const std::string &name) const
	Retrieves the first configuration corresponding to the specified name. More...

FWRUNTIME_API bool	hasConfigurationElement (const std::string &name) const
	Test if has an configuration corresponding to the specified name. More...

FWRUNTIME_API ConfigurationElementContainer	findAllConfigurationElement (const std::string &name) const
	Retrieves the configurations corresponding to the specified name. More...

FWRUNTIME_API size_t	size () const
	Return the number of configurations. More...

Static Public Member Functions
static bool	isTypeOf (const std::string &type)

Static Public Member Functions inherited from fwRuntime::ConfigurationElement
static bool	isTypeOf (const std::string &type)

static const std::string &	classname ()
	return full object's classname with its namespace, i.e. fwCore::BaseObject

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

Additional Inherited Members
Public Types inherited from fwRuntime::ConfigurationElement
typedef std::pair< bool, std::string >	AttributePair
	Defines the attribute pair type.

Public Types inherited from fwRuntime::ConfigurationElementContainer
typedef std::vector< std::shared_ptr< ConfigurationElement > >	Container
	Defines the configuration element container type. More...

typedef Container::iterator	Iterator
	Defines the configuration element container type. More...

Protected Member Functions inherited from fwRuntime::ConfigurationElement
FWRUNTIME_API	ConfigurationElement (const std::shared_ptr< Bundle > bundle, const std::string &name)
	Constructor. More...

FWRUNTIME_API void	setAttributeValue (const std::string &name, const std::string &value) noexcept
	Sets an attribute with the specified name and value. More...

FWRUNTIME_API void	setValue (const std::string &value) noexcept
	Sets the value of the configuration element it-self. More...

Protected Member Functions inherited from fwRuntime::ConfigurationElementContainer
FWRUNTIME_API void	addConfigurationElement (std::shared_ptr< ConfigurationElement > element)
	Adds a new configuration element to the extension. More...

Detailed Description

Editable configuration element : allow the self configuration element building, which reading XML structure provided by bundle descriptions.

Date: 2006-2009

Definition at line 23 of file EConfigurationElement.hpp.

Constructor & Destructor Documentation

fwRuntime::EConfigurationElement::EConfigurationElement ( const std::string & name )

Constructor.

Parameters

[in] name name of the configuration element

Definition at line 14 of file EConfigurationElement.cpp.

Member Function Documentation

EConfigurationElement::sptr fwRuntime::EConfigurationElement::addConfigurationElement ( const std::string & name )

Create and add a configuration element.

Parameters

[in] name name of the configuration element

Returns: the created configuration element

Definition at line 25 of file EConfigurationElement.cpp.

References fwRuntime::ConfigurationElementContainer::addConfigurationElement().

Here is the call graph for this function:

void fwRuntime::EConfigurationElement::addConfigurationElement ( EConfigurationElement::sptr element )

Adds a new configuration element to the extension.

Parameters

[in] element a shared pointer to the configuration element to add

Definition at line 34 of file EConfigurationElement.cpp.

References fwRuntime::ConfigurationElementContainer::addConfigurationElement(), fwRuntime::ConfigurationElement::setAttributeValue(), and fwRuntime::ConfigurationElement::setValue().

Here is the call graph for this function:

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

Public Member Functions

Static Public Member Functions

Friends

Demangling methods

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation