Defines the generic configuration element container class. More...

#include <ConfigurationElementContainer.hpp>

Inheritance diagram for fwRuntime::ConfigurationElementContainer:

Public Types
Type Definitions
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...

Public Member Functions
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...

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

Friends
struct	BundleDescriptorReader

Detailed Description

Defines the generic configuration element container class.

Definition at line 29 of file ConfigurationElementContainer.hpp.

Member Typedef Documentation

typedef std::vector< std::shared_ptr<ConfigurationElement> > fwRuntime::ConfigurationElementContainer::Container

Defines the configuration element container type.

Defines the configuration element container iterator type.

Definition at line 40 of file ConfigurationElementContainer.hpp.

typedef Container::iterator fwRuntime::ConfigurationElementContainer::Iterator

Defines the configuration element container type.

Defines the configuration element container iterator type.

Definition at line 42 of file ConfigurationElementContainer.hpp.

Member Function Documentation

void fwRuntime::ConfigurationElementContainer::addConfigurationElement ( std::shared_ptr< ConfigurationElement > element )

protected

Adds a new configuration element to the extension.

Parameters

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

Definition at line 46 of file ConfigurationElementContainer.cpp.

Referenced by fwRuntime::EConfigurationElement::addConfigurationElement(), and findAllConfigurationElement().

Here is the caller graph for this function:

ConfigurationElementContainer::Iterator fwRuntime::ConfigurationElementContainer::begin ( )

Retrieves the iterator on the first managed configuration element.

Returns: an iterator

Definition at line 53 of file ConfigurationElementContainer.cpp.

Referenced by ioDcmtk::SSeriesDBReader::configuring(), fwRuntime::ConfigurationElement::find(), fwRuntime::getAllExecutableForPoint(), and dataReg::parser::GenericField::updating().

Here is the caller graph for this function:

ConfigurationElementContainer::Iterator fwRuntime::ConfigurationElementContainer::end ( )

Retrieves the iterator on the end of the configuration element container.

Returns: an iterator

Definition at line 60 of file ConfigurationElementContainer.cpp.

Referenced by ioDcmtk::SSeriesDBReader::configuring(), fwRuntime::ConfigurationElement::find(), and fwRuntime::getAllExecutableForPoint().

Here is the caller graph for this function:

ConfigurationElementContainer fwRuntime::ConfigurationElementContainer::findAllConfigurationElement ( const std::string & name ) const

Retrieves the configurations corresponding to the specified name.

Parameters

[in] name a string containing a configuration element name

Returns: a configuration element container that contains configuration element instances

Definition at line 92 of file ConfigurationElementContainer.cpp.

References addConfigurationElement().

Referenced by gui::action::SSlotCaller::configuring(), and ioDcmtk::SSeriesDBReader::configuring().

Here is the call graph for this function:

Here is the caller graph for this function:

const std::shared_ptr< ConfigurationElement > fwRuntime::ConfigurationElementContainer::findConfigurationElement ( const std::string & name ) const

Retrieves the first configuration corresponding to the specified name.

Parameters

[in] name a string containing a configuration element name

Returns: a pointer to a configuration element instance or null if none

Definition at line 82 of file ConfigurationElementContainer.cpp.

const ConfigurationElementContainer::Container & fwRuntime::ConfigurationElementContainer::getElements ( ) const

Returns the configuration element container.

Returns: an configuration element container

Definition at line 67 of file ConfigurationElementContainer.cpp.

Referenced by gui::action::SSlotCaller::configuring(), uiPreferences::action::SPreferencesConfiguration::configuring(), and fwServices::helper::Config::createProxy().

Here is the caller graph for this function:

bool fwRuntime::ConfigurationElementContainer::hasConfigurationElement ( const std::string & name ) const

Test if has an configuration corresponding to the specified name.

Parameters

[in] name a string containing a configuration element name

Returns: true if the method find at least one configuration

Definition at line 74 of file ConfigurationElementContainer.cpp.

size_t fwRuntime::ConfigurationElementContainer::size ( ) const

Return the number of configurations.

Returns: Return the number of configurations

Definition at line 112 of file ConfigurationElementContainer.cpp.

Referenced by dataReg::parser::GenericField::updating().

Here is the caller graph for this function:

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

Public Types

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

Member Function Documentation