PlotView::Factory Class Reference

A factory for PlotView::Dispatcher objects. This factory defines an extension point for PointView::Dispatcher (rws.PlotView). Typically this is for plugins that provide widgets capable of showing and interacting with plots. The extensions registered at this extension point must have an extension descriptor with a property called "identifier" giving a unique identifier for that particular type of PlotView. More...

#include <PlotView.hpp>

Inherits ExtensionPoint< Dispatcher >.

Static Public Member Functions
static rw::core::Ptr< PlotView >	makePlotView (const std::string &identifier)
	Construct a new PlotView. More...
static bool	hasPlotViewDispatcher (const std::string &identifier)
	Check if the factory has a specific PlotView::Dispatcher. More...
static std::vector< std::string >	getIdentifiers ()
	Get a list of identifiers. More...

Additional Inherited Members
Public Types inherited from ExtensionPoint< Dispatcher >
typedef rw::core::Ptr< ExtensionPoint >	Ptr
	smart pointer type of ExtensionPoint
Public Member Functions inherited from ExtensionPoint< Dispatcher >
	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::core::PropertyMap &	getSchema () 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< rw::core::Extension::Descriptor >	getExtensionDescriptors () const
	get all extension descriptions of this extension point
std::vector< rw::core::Ptr< Extension > >	getExtensions () const
	get all extensions of this extension point
Protected Member Functions inherited from ExtensionPoint< Dispatcher >
rw::core::PropertyMap &	getSchema ()
	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 PlotView::Dispatcher objects. This factory defines an extension point for PointView::Dispatcher (rws.PlotView). Typically this is for plugins that provide widgets capable of showing and interacting with plots. The extensions registered at this extension point must have an extension descriptor with a property called "identifier" giving a unique identifier for that particular type of PlotView.

Member Function Documentation

getIdentifiers()

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

static

Get a list of identifiers.

Returns

a list of identifiers for PlotView::Dispatcher implementations.

hasPlotViewDispatcher()

static bool hasPlotViewDispatcher ( const std::string &  identifier )

static

Check if the factory has a specific PlotView::Dispatcher.

Parameters

identifier

[in] name of the implementation.

Returns

true if implementation was found, false otherwise.

makePlotView()

static rw::core::Ptr<PlotView> makePlotView ( const std::string &  identifier )

static

Construct a new PlotView.

Parameters

identifier

[in] name of the implementation to use.

Returns

a PlotView if PlotView::Dispatcher with identifier is found, nullptr otherwise.

---

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

• PlotView.hpp