RobWorkProject
Public Member Functions | Static Public Member Functions | List of all members
WorkCellLoader::Factory Class Reference

a factory for WorkCellLoader. This factory also defines an extension point for workcell loaders. More...

#include <WorkCellLoader.hpp>

Inherits ExtensionPoint< WorkCellLoader >.

Public Member Functions

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

Static Public Member Functions

static rw::common::Ptr< WorkCellLoadergetWorkCellLoader (const std::string &format)
 Get loaders for a specific format. More...
 
static models::WorkCell::Ptr load (const std::string &filename)
 Loads/imports a workcell from a file. An exception is thrown if the file can't be loaded. XML as well as TUL workcell formats are supported. More...
 

Additional Inherited Members

- Public Types inherited from ExtensionPoint< WorkCellLoader >
typedef rw::common::Ptr< ExtensionPointPtr
 smart pointer type of ExtensionPoint
 
- Protected Member Functions inherited from ExtensionPoint< WorkCellLoader >
rw::common::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 WorkCellLoader. This factory also defines an extension point for workcell loaders.

Member Function Documentation

◆ getWorkCellLoader()

static rw::common::Ptr<WorkCellLoader> getWorkCellLoader ( const std::string &  format)
static

Get loaders for a specific format.

Parameters
format[in] the extension (including initial dot).
Returns
a suitable loader.

◆ load()

static models::WorkCell::Ptr load ( const std::string &  filename)
static

Loads/imports a workcell from a file. An exception is thrown if the file can't be loaded. XML as well as TUL workcell formats are supported.

Parameters
filename[in] name of workcell file.

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