RobWorkProject
Classes | Public Types | Public Member Functions | Friends | List of all members
Extension Class Reference

The Extension class is used to provide additonal functionality from a Plugin to other extension points of either the system or other plugins. More...

#include <Extension.hpp>

Classes

struct  Descriptor
 An extension descriptor. More...
 

Public Types

typedef rw::common::Ptr< ExtensionPtr
 Smart pointer type for Extension.
 

Public Member Functions

 Extension (Descriptor desc, Plugin *owner)
 Constructor. More...
 
 Extension (const std::string &id, const std::string &point, Plugin *owner)
 Constructor. More...
 
 Extension (const std::string &id, const std::string &point, Plugin *owner, rw::common::AnyPtr obj)
 Constructor. More...
 
virtual ~Extension ()
 Destructor.
 
const std::string & getId ()
 a unique id that uniquely identifies this extension in its owner Plugin
 
const std::string & getName ()
 a human readable name of this plugin (may contain spaces)
 
const std::string & getPoint () const
 a unique global identifier of the extension point that this extension is attached to
 
const rw::common::PropertyMapgetProperties () const
 the properties/configuration of this extension
 
rw::common::PropertyMapgetProperties ()
 the properties/configuration of this extension More...
 
virtual rw::common::AnyPtr getObject ()
 Get the object. More...
 
PlugingetOwner ()
 get the owner plugin
 

Friends

class Plugin
 an interface for defining dynamically loadable plugins that define extensions and extension points. More...
 

Detailed Description

The Extension class is used to provide additonal functionality from a Plugin to other extension points of either the system or other plugins.

Extension points in RobWork:

rw.common.DOMParser (rw::common::DOMParser::Factory): for extensions of type rw::common::DOMParser

rw.loaders.ImageLoader (rw::loaders::ImageLoader::Factory): for extensions of type rw::loaders::ImageLoader

rw.loaders.Model3DLoader (rw::loaders::Model3DLoader::Factory): for extensions of type rw::loaders::Model3DLoader

% rw.loaders.WorkCellLoader (rw::loaders::WorkCellLoader::Factory): for extensions of type rw::loaders::WorkCellLoader

rw::pathplanning::QToTPlanner (rw::pathplanning::QToTPlanner::Factory): for extensions of type rw::pathplanning::QToTPlanner

rw.proximity.CollisionStrategy (rw::proximity::CollisionStrategy::Factory): for extensions of type rw::proximity::CollisionStrategy

rw.proximity.CollisionToleranceStrategy (rw::proximity::CollisionToleranceStrategy::Factory): for extensions of type rw::proximity::CollisionToleranceStrategy

rw.proximity.DistanceMultiStrategy (rw::proximity::DistanceMultiStrategy::Factory): for extensions of type rw::proximity::DistanceMultiStrategy

rw.proximity.DistanceStrategy (rw::proximity::DistanceStrategy::Factory): for extensions of type rw::proximity::DistanceStrategy

rw.proximity.ProximityStrategy (rw::proximity::ProximityStrategy::Factory): for extensions of type rw::proximity::ProximityStrategy

rwlibs.assembly.AssemblyControlStrategy (rwlibs::assembly::AssemblyRegistry): for extensions of type rwlibs::assembly::AssemblyControlStrategy

rwlibs.swig.LuaState.LuaLibrary (rwlibs::swig::LuaState::Factory): for extensions of type rwlibs::swig::LuaState::LuaLibrary

% rwlibs.task.TaskLoader (rwlibs::task::TaskLoader::Factory): for extensions of type rwlibs::task::TaskLoader

% rwlibs.task.TaskSaver (rwlibs::task::TaskSaver::Factory): for extensions of type rwlibs::task::TaskSaver

rwsim.log.SimulatorLogEntry (rwsim::log::SimulatorLogEntry::Factory): for extensions of type rwsim::log::SimulatorLogEntry

rwsim.simulator.PhysicsEngine (rwsim::simulator::PhysicsEngine::Factory): for extensions of type rwsim::simulator::PhysicsEngine::Dispatcher

rwsimlibs.gui.SimulatorLogEntryWidget (rwsimlibs::gui::SimulatorLogEntryWidget::Factory): for extensions of type rwsimlibs::gui::SimulatorLogEntryWidget::Dispatcher

rwsimlibs.rwpe.RWPECollisionSolver (rwsimlibs::rwpe::RWPECollisionSolver::Factory): for extensions of type rwsimlibs::rwpe::RWPECollisionSolver

rwsimlibs.rwpe.RWPEConstraintSolver (rwsimlibs::rwpe::RWPEConstraintSolver::Factory): for extensions of type rwsimlibs::rwpe::RWPEConstraintSolver

rwsimlibs.rwpe.RWPEContactResolver (rwsimlibs::rwpe::RWPEContactResolver::Factory): for extensions of type rwsimlibs::rwpe::RWPEContactResolver

rwsimlibs.rwpe.RWPEFrictionModel (rwsimlibs::rwpe::RWPEFrictionModel::Factory): for extensions of type rwsimlibs::rwpe::RWPEFrictionModel

rwsimlibs.rwpe.RWPEIntegrator (rwsimlibs::rwpe::RWPEIntegrator::Factory): for extensions of type rwsimlibs::rwpe::RWPEIntegrator

rwsimlibs.rwpe.RWPERestitutionModel (rwsimlibs::rwpe::RWPERestitutionModel::Factory): for extensions of type rwsimlibs::rwpe::RWPERestitutionModel

rwsimlibs.rwpe.RWPERollbackMethod (rwsimlibs::rwpe::RWPERollbackMethod::Factory): for extensions of type rwsimlibs::rwpe::RWPERollbackMethod

rwsimlibs.test.EngineTest (rwsimlibs::test::EngineTest::Factory): for extensions of type rwsimlibs::test::EngineTest

Constructor & Destructor Documentation

◆ Extension() [1/3]

Extension ( Descriptor  desc,
Plugin owner 
)

Constructor.

Parameters
desc[in] Description and configuration of extension.
owner[in] the plugin that owns this extension or NULL.

◆ Extension() [2/3]

Extension ( const std::string &  id,
const std::string &  point,
Plugin owner 
)

Constructor.

Parameters
id[in] a unique id of the extension.
point[in] the extension point.
owner[in] the plugin that owns this extension or NULL.

◆ Extension() [3/3]

Extension ( const std::string &  id,
const std::string &  point,
Plugin owner,
rw::common::AnyPtr  obj 
)

Constructor.

Parameters
id[in] a unique id of the extension.
point[in] the extension point.
owner[in] the plugin that owns this extension or NULL.
obj[in] a pointer to the object.

Member Function Documentation

◆ getObject()

virtual rw::common::AnyPtr getObject ( )
inlinevirtual

Get the object.

Returns
the object.

◆ getProperties()

rw::common::PropertyMap& getProperties ( )
inline

the properties/configuration of this extension

Friends And Related Function Documentation

◆ Plugin

friend class Plugin
friend

an interface for defining dynamically loadable plugins that define extensions and extension points.


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