RobWorkProject
Classes | Public Types | Public Member Functions | List of all members
TaskLoader Class Referenceabstract

Interface for loaders of the task format. More...

#include <TaskLoader.hpp>

Inherited by DOMTaskLoader, and XMLTaskLoader.

Classes

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

Public Types

typedef rw::common::Ptr< TaskLoaderPtr
 Smart pointer type for a TaskLoader.
 

Public Member Functions

 TaskLoader ()
 Constructor.
 
virtual ~TaskLoader ()
 Destructor.
 
virtual void load (const std::string &filename, const std::string &schemaFileName="")=0
 Load a task from a file. More...
 
virtual void load (std::istream &instream, const std::string &schemaFileName="")=0
 Load a task from an input stream. More...
 
virtual rwlibs::task::QTask::Ptr getQTask ()=0
 Get an already loaded QTask. More...
 
virtual rwlibs::task::CartesianTask::Ptr getCartesianTask ()=0
 Get an already loaded CartesianTask. More...
 
virtual rwlibs::task::TaskBase::Ptr getTask ()=0
 Get an already loaded Task. More...
 
virtual TaskLoader::Ptr clone () const =0
 Clone the TaskLoader. More...
 

Detailed Description

Interface for loaders of the task format.

Member Function Documentation

◆ clone()

virtual TaskLoader::Ptr clone ( ) const
pure virtual

Clone the TaskLoader.

Returns
a new copy of the TaskLoader object.

Implemented in XMLTaskLoader, and DOMTaskLoader.

◆ getCartesianTask()

virtual rwlibs::task::CartesianTask::Ptr getCartesianTask ( )
pure virtual

Get an already loaded CartesianTask.

Returns
smart pointer to the CartesianTask, or NULL if no CartesianTask has been loaded.

Implemented in XMLTaskLoader, and DOMTaskLoader.

◆ getQTask()

virtual rwlibs::task::QTask::Ptr getQTask ( )
pure virtual

Get an already loaded QTask.

Returns
smart pointer to the QTask, or NULL if no QTask has been loaded.

Implemented in XMLTaskLoader, and DOMTaskLoader.

◆ getTask()

virtual rwlibs::task::TaskBase::Ptr getTask ( )
pure virtual

Get an already loaded Task.

Returns
smart pointer to the Task, or NULL if no Task has been loaded.

Implemented in XMLTaskLoader, and DOMTaskLoader.

◆ load() [1/2]

virtual void load ( const std::string &  filename,
const std::string &  schemaFileName = "" 
)
pure virtual

Load a task from a file.

Parameters
filename[in] the filename.
schemaFileName[in] (optional) a schema describing the layout.

Implemented in XMLTaskLoader, and DOMTaskLoader.

◆ load() [2/2]

virtual void load ( std::istream &  instream,
const std::string &  schemaFileName = "" 
)
pure virtual

Load a task from an input stream.

Parameters
instream[in] the stream to load from.
schemaFileName[in] (optional) a schema describing the layout.

Implemented in XMLTaskLoader, and DOMTaskLoader.


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