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

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

#include <DistanceMultiStrategy.hpp>

Inherits ExtensionPoint< DistanceMultiStrategy >.

Static Public Member Functions

static std::vector< std::string > getStrategies ()
 Get the available strategies. More...
 
static bool hasStrategy (const std::string &strategy)
 Check if strategy is available. More...
 
static DistanceMultiStrategy::Ptr makeStrategy (const std::string &strategy)
 Create a new strategy. More...
 

Additional Inherited Members

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

Extensions providing a DistanceMultiStrategy implementation can extend this factory by registering the extension using the id "rw.proximity.DistanceMultiStrategy".

Typically one or more of the following DistanceMultiStrategy types will be available:

Member Function Documentation

◆ getStrategies()

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

Get the available strategies.

Returns
a vector of identifiers for strategies.

◆ hasStrategy()

static bool hasStrategy ( const std::string &  strategy)
static

Check if strategy is available.

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

◆ makeStrategy()

static DistanceMultiStrategy::Ptr makeStrategy ( const std::string &  strategy)
static

Create a new strategy.

Parameters
strategy[in] the name of the strategy.
Returns
a pointer to a new DistanceMultiStrategy.

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