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

A factory for a RWPEFrictionModel. This factory also defines an ExtensionPoint. More...

#include <RWPEFrictionModel.hpp>

Inherits ExtensionPoint< RWPEFrictionModel >.

Static Public Member Functions

static std::vector< std::string > getModels ()
 Get the available models. More...
 
static bool hasModel (const std::string &model)
 Check if model is available. More...
 
static const RWPEFrictionModelmakeModel (const std::string &model, const rw::common::PropertyMap &properties)
 Create a new model. More...
 

Additional Inherited Members

- Public Types inherited from ExtensionPoint< RWPEFrictionModel >
typedef rw::common::Ptr< ExtensionPointPtr
 smart pointer type of ExtensionPoint
 
- Public Member Functions inherited from ExtensionPoint< RWPEFrictionModel >
 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< RWPEFrictionModel >
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 RWPEFrictionModel. This factory also defines an ExtensionPoint.

By default the factory provides the following RWPEFrictionModel types:

Member Function Documentation

◆ getModels()

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

Get the available models.

Returns
a vector of identifiers for models.

◆ hasModel()

static bool hasModel ( const std::string &  model)
static

Check if model is available.

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

◆ makeModel()

static const RWPEFrictionModel* makeModel ( const std::string &  model,
const rw::common::PropertyMap properties 
)
static

Create a new model.

Parameters
model[in] the name of the model.
properties[in] a map of properties with the required parameters for the given model.
Returns
a pointer to a new RWPEFrictionModel owned by the caller (can return NULL if properties are not as expected).

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