RobWorkProject  24.5.15-
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::core::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::core::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
 
rw::core::PropertyMapgetProperties ()
 the properties/configuration of this extension More...
 
const rw::core::PropertyMapgetProperties () const
 the properties/configuration of this extension
 
virtual rw::core::AnyPtr getObject ()
 Get the object. More...
 
PlugingetOwner ()
 get the owner plugin
 

Friends

class Plugin
 

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.core.DOMParser ( rw::core::DOMParser::Factory): for extensions of type rw::core::DOMParser

rw.loaders.CSGEngine (rw::geometry::CSGEngine::Factory): for extensions of type rw::loaders::CSGEngine

rw.graphics.PlotGenerator ( rw::graphics::PlotGenerator::Factory): for extensions of type rw::graphics::PlotGenerator

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

rws.PlotViewPlugin ( rws::PlotViewPlugin::Factory): for extensions of type rws::PlotViewPlugin

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.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::core::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::core::AnyPtr getObject ( )
inlinevirtual

Get the object.

Returns
the object.

◆ getProperties()

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

the properties/configuration of this extension


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