RobWorkProject  24.5.15-
Public Member Functions | Static Public Member Functions | List of all members
CSGEngine::Factory Class Reference

a factory for CSGEngine. This factory defines an extension point for CSGEngine. More...

#include <CSGEngine.hpp>

Inherits ExtensionPoint< CSGEngine >.

Public Member Functions

 Factory ()
 constructor
 
- Public Member Functions inherited from ExtensionPoint< CSGEngine >
 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::PropertyMapgetSchema () 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::DescriptorgetExtensionDescriptors () const
 get all extension descriptions of this extension point
 
std::vector< rw::core::Ptr< Extension > > getExtensions () const
 get all extensions of this extension point
 

Static Public Member Functions

static CSGEngine::Ptr getDefaultEngine ()
 Get the First CSGEngine in the list. More...
 
static void setDefaultEngine (CSGEngine::Ptr engine)
 set the default CSGEngine More...
 
static std::vector< std::string > getAvailableEngines ()
 get a list a valid Engine id's More...
 
static bool hasEngine (const std::string &engine)
 Check if engine is available. More...
 
static CSGEngine::Ptr getCSGEngine (std::string id)
 get a specific engine. More...
 

Additional Inherited Members

- Public Types inherited from ExtensionPoint< CSGEngine >
typedef rw::core::Ptr< ExtensionPointPtr
 smart pointer type of ExtensionPoint
 
- Protected Member Functions inherited from ExtensionPoint< CSGEngine >
rw::core::PropertyMapgetSchema ()
 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 CSGEngine. This factory defines an extension point for CSGEngine.

Member Function Documentation

◆ getAvailableEngines()

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

get a list a valid Engine id's

Returns
std::vector< std::string >

◆ getCSGEngine()

static CSGEngine::Ptr getCSGEngine ( std::string  id)
static

get a specific engine.

Parameters
id[in] id of the engine
Returns
Null if engine not found else returns the engine

◆ getDefaultEngine()

static CSGEngine::Ptr getDefaultEngine ( )
static

Get the First CSGEngine in the list.

Returns
CSGEngine or NULL if no Engine is Found

◆ hasEngine()

static bool hasEngine ( const std::string &  engine)
static

Check if engine is available.

Parameters
engine[in] the name of the engine.
Returns
true if available, false otherwise.

◆ setDefaultEngine()

static void setDefaultEngine ( CSGEngine::Ptr  engine)
static

set the default CSGEngine

Parameters
engine[in] the engine to use

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