ProximityStrategyFactory Class Reference

Factory class that enables constructing collision strategies. More...

#include <ProximityStrategyFactory.hpp>

Static Public Member Functions
static std::vector< std::string >	getCollisionStrategyIDs ()
	Get a list of all available CollisionStrategiy ID's. More...
static rw::proximity::CollisionStrategy::Ptr	makeDefaultCollisionStrategy ()
	function to create a default available collision strategy More...
static rw::proximity::CollisionStrategy::Ptr	makeCollisionStrategy (const std::string &id)
	function to create a collision strategy from an ID More...
static std::vector< std::string >	getDistanceStrategyIDs ()
	Get a list of all available DistanceStrategiy ID's. More...
static rw::proximity::DistanceStrategy::Ptr	makeDefaultDistanceStrategy ()
	function to create a default available distance strategy More...
static rw::proximity::DistanceStrategy::Ptr	makeDistanceStrategy (const std::string &id)
	function to create a distance strategy from an ID More...
static std::vector< std::string >	getDistanceMultiStrategyIDs ()
	Get a list of all available DistanceMultiStrategiy ID's. More...
static rw::proximity::DistanceMultiStrategy::Ptr	makeDefaultDistanceMultiStrategy ()
	function to create a default available distance multi strategy More...
static rw::proximity::DistanceMultiStrategy::Ptr	makeDistanceMultiStrategy (const std::string &id)
	function to create a distance multi strategy from an ID More...

Detailed Description

Factory class that enables constructing collision strategies.

Member Function Documentation

getCollisionStrategyIDs()

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

static

Get a list of all available CollisionStrategiy ID's.

Returns

A vector of ID's

getDistanceMultiStrategyIDs()

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

static

Get a list of all available DistanceMultiStrategiy ID's.

Returns

A vector of ID's

getDistanceStrategyIDs()

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

static

Get a list of all available DistanceStrategiy ID's.

Returns

A vector of ID's

makeCollisionStrategy()

static rw::proximity::CollisionStrategy::Ptr makeCollisionStrategy ( const std::string &  id )

static

function to create a collision strategy from an ID

Parameters

id	[in] the id of the collision strategy

Returns

NULL if the id dosn't match an available collision strategies else a Ptr to the collision strategy

makeDefaultCollisionStrategy()

static rw::proximity::CollisionStrategy::Ptr makeDefaultCollisionStrategy ( )

static

function to create a default available collision strategy

Returns

NULL if no collision strategies are available else a Ptr to a collision strategy

makeDefaultDistanceMultiStrategy()

static rw::proximity::DistanceMultiStrategy::Ptr makeDefaultDistanceMultiStrategy ( )

static

function to create a default available distance multi strategy

Returns

NULL if no distance multi strategies are available else a Ptr to a distance multi strategy

makeDefaultDistanceStrategy()

static rw::proximity::DistanceStrategy::Ptr makeDefaultDistanceStrategy ( )

static

function to create a default available distance strategy

Returns

NULL if no distancestrategies are available else a Ptr to a distance strategy

makeDistanceMultiStrategy()

static rw::proximity::DistanceMultiStrategy::Ptr makeDistanceMultiStrategy ( const std::string &  id )

static

function to create a distance multi strategy from an ID

Parameters

id	[in] the id of the distance multi strategy

Returns

NULL if the id dosn't match an available distance multi strategies else a Ptr to the distnace multi strategy

makeDistanceStrategy()

static rw::proximity::DistanceStrategy::Ptr makeDistanceStrategy ( const std::string &  id )

static

function to create a distance strategy from an ID

Parameters

id	[in] the id of the distance strategy

Returns

NULL if the id dosn't match an available distance trategies else a Ptr to the distance strategy

---

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

• ProximityStrategyFactory.hpp