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

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

#include <RWPEContactResolver.hpp>

Inherits ExtensionPoint< RWPEContactResolver >.

Static Public Member Functions

static std::vector< std::string > getResolvers ()
 Get the available resolver types. More...
 
static bool hasResolver (const std::string &resolverType)
 Check if resolver type is available. More...
 
static const RWPEContactResolvermakeResolver (const std::string &resolverType, const RWPEConstraintSolver *solver)
 Create a new resolver. More...
 

Additional Inherited Members

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

By default the factory provides the following RWPEContactResolver types:

Member Function Documentation

◆ getResolvers()

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

Get the available resolver types.

Returns
a vector of identifiers for resolvers.

◆ hasResolver()

static bool hasResolver ( const std::string &  resolverType)
static

Check if resolver type is available.

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

◆ makeResolver()

static const RWPEContactResolver* makeResolver ( const std::string &  resolverType,
const RWPEConstraintSolver solver 
)
static

Create a new resolver.

Parameters
resolverType[in] the name of the solver.
solver[in] a pointer to the solver to use.
Returns
a pointer to a new RWPEContactResolver - the pointer is owned by the caller.

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