#include <AlgorithmFactory.hh>

Collaboration diagram for AlgorithmFactory:

Classes
class	DLL

Public Member Functions
	~AlgorithmFactory ()

Static Public Member Functions
static void	setDefaultAlgDir (std::string const dir)

static std::string	getDefaultAlgDir ()

static int	searchDefaultDirs ()

static int	addDir (const std::string &dirs)

static bool	addDll (const std::string &file)

static AlgMetadata const **	availableAlgorithms ()

static int	numAvailableAlgorithms ()

static AlgMetadata const *	algorithmMetadata (std::string const algorithm_id)

static AlgorithmPtr	newAlgorithm (std::string const id)

static AlgorithmPtr	newAlgorithm (const ConstConfigurationPtr &)

static ConfigurationPtr	getConfiguration ()

static std::string const	getCurrentId (std::string const algorithm_id)

Private Types
typedef ReferenceCountedPointer< DLL >	DLLPtr

typedef std::list< DLLPtr >	ListDLL

typedef std::list< std::string >	PluginPath

Private Member Functions
	AlgorithmFactory ()

int	p_addDir (const std::string &dir)

bool	p_addDll (const std::string &file)

Static Private Member Functions
static AlgorithmFactory &	getInstance ()

Private Attributes
std::string	_default_alg_dir

ListDLL	_dlls

PluginPath	_pluginpath

Friends
class	testDLLId

Detailed Description

Responsable for instantiate algorithms.

Obs: Besides instantiate the algorithms it does not sets the Sampler object of the algorithms. So, before use an algorithm returned by this classe one needs to calls the method Algorithm::setSample().

Definition at line 55 of file AlgorithmFactory.hh.

Member Typedef Documentation

typedef ReferenceCountedPointer<DLL> AlgorithmFactory::DLLPtr

private

Definition at line 167 of file AlgorithmFactory.hh.

typedef std::list<DLLPtr> AlgorithmFactory::ListDLL

private

Definition at line 169 of file AlgorithmFactory.hh.

typedef std::list<std::string> AlgorithmFactory::PluginPath

private

Definition at line 170 of file AlgorithmFactory.hh.

Constructor & Destructor Documentation

AlgorithmFactory::~AlgorithmFactory ( )

Definition at line 177 of file AlgorithmFactory.cpp.

AlgorithmFactory::AlgorithmFactory ( )

private

Definition at line 168 of file AlgorithmFactory.cpp.

Member Function Documentation

int AlgorithmFactory::addDir ( const std::string & dirs )

static

Search for all DLLs in some directories.

Parameters

dirs	null terminated string representing a directory to scan

Returns: Number of DLLs found.

Definition at line 366 of file AlgorithmFactory.cpp.

References getInstance(), and p_addDir().

Referenced by searchDefaultDirs().

Here is the call graph for this function:

bool AlgorithmFactory::addDll ( const std::string & file )

static

Add a single file to the DLL search list.

Parameters

file	name of dll file to attempt to load

Returns: true for success.

Definition at line 404 of file AlgorithmFactory.cpp.

References getInstance(), and p_addDll().

Here is the call graph for this function:

AlgMetadata const * AlgorithmFactory::algorithmMetadata ( std::string const algorithm_id )

static

Returns an specific algorithm metadata

Parameters

algorithm_id Identifier of the algorithm.

Returns: Algorithm's metadata or zero if there algorithm was not found.

Definition at line 257 of file AlgorithmFactory.cpp.

References _dlls, Log::error(), getCurrentId(), getInstance(), and Log::instance().

Referenced by OpenModeller::algorithmMetadata(), and main().

Here is the call graph for this function:

AlgMetadata const ** AlgorithmFactory::availableAlgorithms ( )

static

Finds the system available algorithms.

Note that the returned algorithms can not run because they are not initialized with "Sampler" and parameters! To do so, use the method newAlgorithm().

The pointer to the array must be deallocated by the caller using delete []. However, the individual AlgMetadata*'s in the array must not be deallocated. For instance:

AlgMetadata const **algorithms = om->availableAlgorithms(); // do something delete [] algorithms;

Returns: a null terminated list of available algorithms.

Definition at line 213 of file AlgorithmFactory.cpp.

References _dlls, getInstance(), and metadata.

Referenced by OpenModeller::availableAlgorithms().

Here is the call graph for this function:

ConfigurationPtr AlgorithmFactory::getConfiguration ( )

static

Definition at line 435 of file AlgorithmFactory.cpp.

Referenced by main().

Here is the call graph for this function:

string const AlgorithmFactory::getCurrentId ( std::string const algorithm_id )

static

Returns the current algorithm id in case it matches one of the previous ids of an algorithm. This method was created to allow changes in algorithm ids without breaking compatibility with serialized data.

Parameters

algorithm_id Identifier of an algorithm.