RobWorkProject  24.8.23-
Classes | Public Member Functions | List of all members
XMLTaskLoader Class Reference

Loader for the XML task format, based on Xerces. More...

#include <XMLTaskLoader.hpp>

Inherits TaskLoader.

Classes

class  Initializer
 Utility class which initializes local static variables. More...
 

Public Member Functions

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

Additional Inherited Members

- Public Types inherited from TaskLoader
typedef rw::core::Ptr< TaskLoaderPtr
 Smart pointer type for a TaskLoader.
 

Detailed Description

Loader for the XML task format, based on Xerces.

Please consider using the newer DOMTaskLoader instead.

Member Function Documentation

◆ clone()

TaskLoader::Ptr clone ( ) const
virtual

Clone the TaskLoader.

Returns
a new copy of the TaskLoader object.

Implements TaskLoader.

◆ getCartesianTask()

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

Get an already loaded CartesianTask.

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

Implements TaskLoader.

◆ getQTask()

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

Get an already loaded QTask.

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

Implements TaskLoader.

◆ getTask()

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

Get an already loaded Task.

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

Implements TaskLoader.

◆ load() [1/2]

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

Load a task from a file.

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

Implements TaskLoader.

◆ load() [2/2]

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

Load a task from an input stream.

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

Implements TaskLoader.


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