MMM::SensorFactory Class Reference

Inheritance diagram for MMM::SensorFactory:

Public Member Functions
virtual SensorPtr	createSensor (simox::xml::RapidXMLWrapperNodePtr sensorNode, const std::filesystem::path &filePath)=0
virtual std::vector< SensorPtr >	createSensors (LegacyMotionPtr)
virtual std::string	getName ()=0
Public Member Functions inherited from MMM::AbstractFactoryMethod< SensorFactory, void * >
bool	checkBase ()
	Checks if the Plugin is valid base class.
std::string	getDescription () const
	Return the description of the current instance.
std::string	getPath () const
	Return the path of the current instance.
void	setDescription (const std::string &newDescription)
	Set a description on the instance it is called on.
void	setPath (const std::string &path)
	Set a path on the instance it is called on.

Static Public Member Functions
static std::filesystem::path	getStandardLibPath ()
Static Public Member Functions inherited from MMM::AbstractFactoryMethod< SensorFactory, void * >
static std::shared_ptr< SensorFactory >	createInstance (void *)
	Initialisation function which needs to be provided by every subclass. More...
static std::shared_ptr< SensorFactory >	first (void * params)
	Function which can be used to retrieve the first registered object.
static std::shared_ptr< SensorFactory >	fromName (const std::string &name, void * params)
	Function which can be used to retrieve an object specified by string name.
static std::string	getName ()
	Returns the class's name. More...
static std::vector< std::string >	getSubclassList ()
	Return a list of all registered subclasses.
static void	registerClass (const std::string &name, initialisationFunction init)
	Statically called by subclasses to register their name and initialisation function so they can be found by fromName.

Static Public Attributes
static constexpr const char *	VERSION = "1.0"

Additional Inherited Members
Public Types inherited from MMM::AbstractFactoryMethod< SensorFactory, void * >
typedef std::shared_ptr< SensorFactory >(*	initialisationFunction) (void *)
	The function pointer type of subclass initialisation functions. More...

Member Function Documentation

createSensor()

virtual SensorPtr MMM::SensorFactory::createSensor ( simox::xml::RapidXMLWrapperNodePtr  sensorNode, const std::filesystem::path &  filePath  )

pure virtual

Creates a sensor from an xml representation.

Parameters

sensorNode

The sensor xml node.

Implemented in MMM::CustomSensorFactory, MMM::EnvironmentalContactSensorFactory, MMM::Force1DSensorFactory, MMM::Force3DSensorFactory, MMM::IMUSensorFactory, MMM::KinematicSensorFactory, MMM::MoCapMarkerSensorFactory, MMM::ModelPoseSensorFactory, and MMM::WholeBodyDynamicSensorFactory.

createSensors()

virtual std::vector<SensorPtr> MMM::SensorFactory::createSensors ( LegacyMotionPtr  )

inlinevirtual

Creates sensors from a legacy motion if possible.

Reimplemented in MMM::KinematicSensorFactory, and MMM::ModelPoseSensorFactory.

getName()

virtual std::string MMM::SensorFactory::getName ( )

pure virtual

Returns the sensor type as name of the factory.

Implemented in MMM::KinematicSensorFactory, MMM::ModelPoseSensorFactory, MMM::CustomSensorFactory, MMM::EnvironmentalContactSensorFactory, MMM::Force1DSensorFactory, MMM::Force3DSensorFactory, MMM::IMUSensorFactory, MMM::MoCapMarkerSensorFactory, and MMM::WholeBodyDynamicSensorFactory.

---

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

• /builds/sw/mmm/core/MMM/Motion/Sensor/SensorFactory.h