g2o::OptimizationAlgorithmFactory Class Reference

create solvers based on their short name More...

#include <optimization_algorithm_factory.h>

Public Types
typedef std::list< AbstractOptimizationAlgorithmCreator * >	CreatorList

Public Member Functions
OptimizationAlgorithm *	construct (const std::string &tag, OptimizationAlgorithmProperty &solverProperty) const
const CreatorList &	creatorList () const
	return the underlying list of creators More...
void	listSolvers (std::ostream &os) const
	list the known solvers into a stream More...
void	registerSolver (AbstractOptimizationAlgorithmCreator *c)
void	unregisterSolver (AbstractOptimizationAlgorithmCreator *c)

Static Public Member Functions
static void	destroy ()
	free the instance More...
static OptimizationAlgorithmFactory *	instance ()
	return the instance More...

Protected Member Functions
CreatorList::const_iterator	findSolver (const std::string &name) const
CreatorList::iterator	findSolver (const std::string &name)
	OptimizationAlgorithmFactory ()
	~OptimizationAlgorithmFactory ()

Protected Attributes
CreatorList	_creator

Static Private Attributes
static OptimizationAlgorithmFactory *	factoryInstance = 0

Detailed Description

create solvers based on their short name

Factory to allocate solvers based on their short name. The Factory is implemented as a sigleton and the single instance can be accessed via the instance() function.

Definition at line 74 of file optimization_algorithm_factory.h.

Member Typedef Documentation

typedef std::list<AbstractOptimizationAlgorithmCreator*> g2o::OptimizationAlgorithmFactory::CreatorList

Definition at line 77 of file optimization_algorithm_factory.h.

Constructor & Destructor Documentation

g2o::OptimizationAlgorithmFactory::OptimizationAlgorithmFactory ( )

protected

Definition at line 44 of file optimization_algorithm_factory.cpp.

g2o::OptimizationAlgorithmFactory::~OptimizationAlgorithmFactory ( )

protected

Definition at line 48 of file optimization_algorithm_factory.cpp.

Member Function Documentation

OptimizationAlgorithm * g2o::OptimizationAlgorithmFactory::construct	(	const std::string &	tag,
		OptimizationAlgorithmProperty &	solverProperty
	)		const

construct a solver based on its name, e.g., var, fix3_2_cholmod

Definition at line 84 of file optimization_algorithm_factory.cpp.

const CreatorList& g2o::OptimizationAlgorithmFactory::creatorList ( ) const

inline

return the underlying list of creators

Definition at line 104 of file optimization_algorithm_factory.h.

void g2o::OptimizationAlgorithmFactory::destroy ( )

static

free the instance

Definition at line 95 of file optimization_algorithm_factory.cpp.

OptimizationAlgorithmFactory::CreatorList::const_iterator g2o::OptimizationAlgorithmFactory::findSolver ( const std::string &  name ) const

protected

Definition at line 117 of file optimization_algorithm_factory.cpp.

OptimizationAlgorithmFactory::CreatorList::iterator g2o::OptimizationAlgorithmFactory::findSolver ( const std::string &  name )

protected

Definition at line 127 of file optimization_algorithm_factory.cpp.

OptimizationAlgorithmFactory * g2o::OptimizationAlgorithmFactory::instance ( )

static

return the instance

Definition at line 54 of file optimization_algorithm_factory.cpp.

void g2o::OptimizationAlgorithmFactory::listSolvers

(

std::ostream &

os

)

const

list the known solvers into a stream

Definition at line 101 of file optimization_algorithm_factory.cpp.

void g2o::OptimizationAlgorithmFactory::registerSolver

(

AbstractOptimizationAlgorithmCreator *

c

)

register a specific creator for allocating a solver

Definition at line 62 of file optimization_algorithm_factory.cpp.

void g2o::OptimizationAlgorithmFactory::unregisterSolver

(

AbstractOptimizationAlgorithmCreator *

c

)

unregister a specific creator for allocating a solver

Definition at line 74 of file optimization_algorithm_factory.cpp.

Member Data Documentation

CreatorList g2o::OptimizationAlgorithmFactory::_creator

protected

Definition at line 110 of file optimization_algorithm_factory.h.

OptimizationAlgorithmFactory * g2o::OptimizationAlgorithmFactory::factoryInstance = 0

staticprivate

Definition at line 116 of file optimization_algorithm_factory.h.

---

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

• optimization_algorithm_factory.h
• optimization_algorithm_factory.cpp