A factory for a RWPEConstraintSolver. This factory also defines an extension point for RWPEConstraintSolver. More...

#include <RWPEConstraintSolver.hpp>

Static Public Member Functions
static std::vector< std::string >	getSolvers ()
	Get the available solver types. More...

static bool	hasSolver (const std::string &solverType)
	Check if solver type is available. More...

static const RWPEConstraintSolver *	makeSolver (const std::string &solverType, const RWPEBodyConstraintGraph *manager, const rw::math::Vector3D< double > &gravity)
	Create a new solver. More...

Additional Inherited Members
Public Types inherited from ExtensionPoint< RWPEConstraintSolver >
typedef rw::common::Ptr< ExtensionPoint >	Ptr
	smart pointer type of ExtensionPoint

Public Member Functions inherited from ExtensionPoint< RWPEConstraintSolver >
	ExtensionPoint (const std::string &id, const std::string &name, Plugin *plugin=NULL)
	Constructor. More...

const std::string &	getId () const
	get unique identifier of this extensionpoint

const std::string &	getName () const
	get human readable name of this extension point

const rw::common::PropertyMap &	getSchema () const
	the schema describe the possible properties/configurations elements which is used in the PropertyMap. It contain examples of all possible configuration options. This can be used to configure any extensions that needs to attach to this extension point.

std::vector< Extension::Descriptor >	getExtensionDescriptors () const
	get all extension descriptions of this extension point

std::vector< rw::common::Ptr< Extension > >	getExtensions () const
	get all extensions of this extension point

Protected Member Functions inherited from ExtensionPoint< RWPEConstraintSolver >
rw::common::PropertyMap &	getSchema ()
	the schema describe the possible properties/configurations elements which is used in the PropertyMap. The schema property map should just be loaded with all possible configuration options which the extension might use. More...

Detailed Description

A factory for a RWPEConstraintSolver. This factory also defines an extension point for RWPEConstraintSolver.

By default the factory provides the following RWPEConstraintSolver types:

Member Function Documentation

static std::vector<std::string> getSolvers ( )

static

Get the available solver types.

static bool hasSolver ( const std::string & solverType )

static

Check if solver type is available.

Parameters

solverType [in] the name of the solver.

static const RWPEConstraintSolver* makeSolver	(	const std::string &	solverType,
		const RWPEBodyConstraintGraph *	manager,
		const rw::math::Vector3D< double > &	gravity
	)

static

Create a new solver.

Parameters

solverType	[in] the name of the solver.
manager	[in] a pointer to the graph of bodies and constraints to use.
gravity	[in] the gravity in world coordinates.

Returns: a pointer to a new RWPEConstraintSolver - the pointer is owned by the caller.

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