PlotGenerator::Factory Class Reference

A factory for PlotGenerators. This factory defines an extension point for PlotGenerators (rw.graphics.PlotGenerator). Typically this is for generation of plots in the form of images. The extensions registered at this extension point must have an extension descriptor with a property called "generator" giving a unique identifier for that particular generator. More...

#include <PlotGenerator.hpp>

Inherits ExtensionPoint< PlotGenerator >.

Static Public Member Functions
static rw::core::Ptr< PlotGenerator >	getPlotGenerator (const std::string &implementation)
	Get a specific type of PlotGenerator. More...
static bool	hasPlotGenerator (const std::string &implementation)
	Check if the factory has a specific PlotGenerator. More...
static std::vector< std::string >	getPlotGenerators ()
	Get a list of PlotGenerator. More...

Additional Inherited Members
Public Types inherited from ExtensionPoint< PlotGenerator >
typedef rw::core::Ptr< ExtensionPoint >	Ptr
	smart pointer type of ExtensionPoint
Public Member Functions inherited from ExtensionPoint< PlotGenerator >
	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< PlotGenerator >
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 PlotGenerators. This factory defines an extension point for PlotGenerators (rw.graphics.PlotGenerator). Typically this is for generation of plots in the form of images. The extensions registered at this extension point must have an extension descriptor with a property called "generator" giving a unique identifier for that particular generator.

Member Function Documentation

getPlotGenerator()

static rw::core::Ptr<PlotGenerator> getPlotGenerator ( const std::string &  implementation )

static

Get a specific type of PlotGenerator.

Parameters

implementation

[in] name of the implementation to use.

Returns

a PlotGenerator if found, nullptr otherwise.

getPlotGenerators()

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

static

Get a list of PlotGenerator.

Returns

a list of names for generator implementaitons.

hasPlotGenerator()

static bool hasPlotGenerator ( const std::string &  implementation )

static

Check if the factory has a specific PlotGenerator.

Parameters

implementation

[in] name of the implementation.

Returns

true if implementation was found, false otherwise.

---

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

• PlotGenerator.hpp