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

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

#include <TaskSaver.hpp>

Inherited by DOMTaskSaver, and XMLTaskSaver.

Classes

class  Factory
 A factory for TaskSaver. This factory also defines an extension point for task savers. More...
 

Public Types

typedef rw::common::Ptr< TaskSaverPtr
 Smart pointer type for a TaskSaver.
 

Public Member Functions

 TaskSaver ()
 Constructor.
 
virtual ~TaskSaver ()
 Destructor.
 
virtual bool save (rwlibs::task::QTask::Ptr task, std::ostream &outstream)=0
 Save task to output stream. More...
 
virtual bool save (rwlibs::task::CartesianTask::Ptr task, std::ostream &outstream)=0
 Save task to output stream. More...
 
virtual bool save (rwlibs::task::QTask::Ptr task, const std::string &filename)=0
 Save task to file. More...
 
virtual bool save (rwlibs::task::CartesianTask::Ptr task, const std::string &filename)=0
 Save task to file. More...
 

Detailed Description

Interface for savers of the task format.

Member Function Documentation

◆ save() [1/4]

virtual bool save ( rwlibs::task::QTask::Ptr  task,
std::ostream &  outstream 
)
pure virtual

Save task to output stream.

Parameters
task[in] the task to write.
outstream[out] the stream to write to.
Returns
true if write was successful.

Implemented in XMLTaskSaver, XMLTaskSaver, DOMTaskSaver, and DOMTaskSaver.

◆ save() [2/4]

virtual bool save ( rwlibs::task::CartesianTask::Ptr  task,
std::ostream &  outstream 
)
pure virtual

Save task to output stream.

Parameters
task[in] the task to write.
outstream[out] the stream to write to.
Returns
true if write was successful.

Implemented in XMLTaskSaver, XMLTaskSaver, DOMTaskSaver, and DOMTaskSaver.

◆ save() [3/4]

virtual bool save ( rwlibs::task::QTask::Ptr  task,
const std::string &  filename 
)
pure virtual

Save task to file.

Parameters
task[in] the task to save.
filename[in] the filename to save to.
Returns
true if file was written successfully.

Implemented in XMLTaskSaver, XMLTaskSaver, DOMTaskSaver, and DOMTaskSaver.

◆ save() [4/4]

virtual bool save ( rwlibs::task::CartesianTask::Ptr  task,
const std::string &  filename 
)
pure virtual

Save task to file.

Parameters
task[in] the task to save.
filename[in] the filename to save to.
Returns
true if file was written successfully.

Implemented in XMLTaskSaver, XMLTaskSaver, DOMTaskSaver, and DOMTaskSaver.


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