AlgorithmConfig Class Reference
[Algorithms]

the configuration for algorithms. Contains a container of AlgorithmDefinitions as well as methods to access them and a list of present algorithm names. More...

#include <algorithm_config.h>

List of all members.

Public Types
typedef boost::shared_ptr< AlgorithmConfig >	algorithm_config_pointer_type
typedef boost::shared_ptr< AlgorithmDefinition >	algorithm_definition_pointer_type
typedef std::map< std::string, algorithm_definition_pointer_type >	algorithm_definitions_container_type
Public Member Functions
	AlgorithmConfig ()
	~AlgorithmConfig ()
bool	addAlgorithmDefinition (algorithm_definition_pointer_type definition)
algorithm_definition_pointer_type	getAlgorithmDefinition (std::string name) const throw ()
algorithm_definitions_container_type	getAlgorithmDefinitions () const
algorithm_name_container_type	getLoadedAlgorithmNames () const
std::string	getAlgorithmLibraryPath () const
void	setAlgorithmLibraryPath (std::string path)

---

Detailed Description

the configuration for algorithms. Contains a container of AlgorithmDefinitions as well as methods to access them and a list of present algorithm names.

AlgorithmConfig

Configuration for Algorithms. Contains a container of Algorithm definitions as well as the path where the algorithms are located. Provides methods to get a single AlgorithmDefinition by Name and to retrieve all algorithm name strings for display by GUI components.

Author:

Tobias Gross (tobias.gross@imedgine.org)

Christian Koerner (christian.koerner@imedgine.org)

Alexander Lex (alexander.lex@imedgine.org)

Marc Streit (marc.streit@imedgine.org)

Martin Reininger (martin.reininger@imedgine.org)

Definition at line 50 of file algorithm_config.h.

---

Member Typedef Documentation

typedef boost::shared_ptr<AlgorithmConfig> algorithm_config_pointer_type

A shared pointer holding a single AlgorithmConfig Definition at line 58 of file algorithm_config.h.

typedef boost::shared_ptr<AlgorithmDefinition> algorithm_definition_pointer_type

A shared pointer holding a single AlgorithmDefinition Definition at line 64 of file algorithm_config.h.

typedef std::map<std::string, algorithm_definition_pointer_type> algorithm_definitions_container_type

A map of names to AlgorithmDefinitions Definition at line 70 of file algorithm_config.h.

---

Constructor & Destructor Documentation

AlgorithmConfig (   )

Constructor Definition at line 23 of file algorithm_config.cpp.

~AlgorithmConfig (   )

Destructor Definition at line 29 of file algorithm_config.cpp.

---

Member Function Documentation

bool addAlgorithmDefinition (  algorithm_definition_pointer_type  definition  )

add an algorithm definition to the internal container. Parameters: definition  the algorithm definition to add Returns: success indicator Definition at line 35 of file algorithm_config.cpp.

AlgorithmConfig::algorithm_definition_pointer_type getAlgorithmDefinition (  std::string  name  )  const throw ()

Retrieve an algorithm definition Parameters: name  the name of the algorithm Returns: the definition of the algorithm with given name Definition at line 64 of file algorithm_config.cpp.

AlgorithmConfig::algorithm_definitions_container_type getAlgorithmDefinitions (   )  const

Retrieve an algorithm definition Parameters: name  the name of the algorithm Definition at line 42 of file algorithm_config.cpp.

std::string getAlgorithmLibraryPath (   )  const

Get the fully qualified path algorithms are located in. Returns: the path Definition at line 81 of file algorithm_config.cpp.

algorithm_name_container_type getLoadedAlgorithmNames (   )  const

Return all loaded algorithm's names. Returns: a list of strings containing algorithm names Definition at line 49 of file algorithm_config.cpp.

void setAlgorithmLibraryPath (  std::string  path  )

Set the path algorithms are located in (fully qualified) Parameters: path  the path to set Definition at line 88 of file algorithm_config.cpp.

---

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

• imedgine/src/algorithms/algorithm_config.h
• imedgine/src/algorithms/algorithm_config.cpp

---