TaskLoader::Factory Class Reference

A factory for TaskLoader. This factory also defines an extension point for task loaders. More...

#include <TaskLoader.hpp>

Inherits ExtensionPoint< TaskLoader >.

Static Public Member Functions
static TaskLoader::Ptr	getTaskLoader (const std::string &format, const std::string &id="")
	Get loader for a specific format. More...
static bool	hasTaskLoader (const std::string &format)
	Check if the factory has a TaskLoader for a specific format. More...
static std::vector< std::string >	getSupportedFormats ()
	Get a list of supported formats. More...

Additional Inherited Members
Public Types inherited from ExtensionPoint< TaskLoader >
typedef rw::core::Ptr< ExtensionPoint >	Ptr
	smart pointer type of ExtensionPoint
Public Member Functions inherited from ExtensionPoint< TaskLoader >
	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< TaskLoader >
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 TaskLoader. This factory also defines an extension point for task loaders.

Member Function Documentation

getSupportedFormats()

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

static

Get a list of supported formats.

Returns

list of supported formats.

getTaskLoader()

static TaskLoader::Ptr getTaskLoader ( const std::string &  format, const std::string &  id = ""  )

static

Get loader for a specific format.

By default there will be a TaskLoader available for the XML format. If no id is given and there are no (user-added) extensions available for the XML format, a loader based on the DOMParser is used. The DOMParser is always used for the XML format if id is "DOM". If RobWork is compiled with Xerces support, a Xerces based loader is used if id is "Xerces".

Parameters

format	[in] the extension (excluding initial dot).
id	[in] (optional) identifier for a specific loader to use if multiple are available.

Returns

a suitable loader, or NULL if no suitable loader exist.

hasTaskLoader()

static bool hasTaskLoader ( const std::string &  format )

static

Check if the factory has a TaskLoader for a specific format.

Parameters

format

[in] the file ending excluding initial dot (such as xml)

Returns

true if a suitable loader exist, false otherwise.

---

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

• TaskLoader.hpp