RobWorkProject
Static Public Member Functions | List of all members
RWPEIntegrator::Factory Class Reference

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

#include <RWPEIntegrator.hpp>

Inherits ExtensionPoint< RWPEIntegrator >.

Static Public Member Functions

static std::vector< std::string > getIntegrators ()
 Get the available integrator types. More...
 
static bool hasIntegrator (const std::string &integratorType)
 Check if integrator type is available. More...
 
static const RWPEIntegratormakeIntegrator (const std::string &integratorType, const RWPEBodyDynamic *body)
 Create a new integrator. More...
 

Additional Inherited Members

- Public Types inherited from ExtensionPoint< RWPEIntegrator >
typedef rw::common::Ptr< ExtensionPointPtr
 smart pointer type of ExtensionPoint
 
- Public Member Functions inherited from ExtensionPoint< RWPEIntegrator >
 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::PropertyMapgetSchema () 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::DescriptorgetExtensionDescriptors () 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< RWPEIntegrator >
rw::common::PropertyMapgetSchema ()
 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 RWPEIntegrator. This factory also defines an extension point for RWPEIntegrator.

By default the factory provides the following RWPEIntegrator types:

Member Function Documentation

◆ getIntegrators()

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

Get the available integrator types.

Returns
a vector of identifiers for integrators.

◆ hasIntegrator()

static bool hasIntegrator ( const std::string &  integratorType)
static

Check if integrator type is available.

Parameters
integratorType[in] the name of the integrator.
Returns
true if available, false otherwise.

◆ makeIntegrator()

static const RWPEIntegrator* makeIntegrator ( const std::string &  integratorType,
const RWPEBodyDynamic body 
)
static

Create a new integrator.

Parameters
integratorType[in] the name of the integrator.
body[in] the body to create the integrator for.
Returns
a pointer to a new RWPEIntegrator - the pointer is owned by the caller.

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