RobWorkProject  24.5.15-
Classes | Static Public Member Functions | List of all members
DOMPathSaver Class Reference

Class used for saving a Path using the RobWork XML Path Format. More...

#include <DOMPathSaver.hpp>

Classes

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

Static Public Member Functions

static void save (const rw::trajectory::QPath &path, const std::string &filename)
 Saves the rw::trajectory::QPath path to file. More...
 
static void save (const rw::trajectory::Vector3DPath &path, const std::string &filename)
 Saves rw::trajectory::Vector3DPath path to file. More...
 
static void save (const rw::trajectory::Rotation3DPath &path, const std::string &filename)
 Saves rw::trajectory::Rotation3DPath path to file. More...
 
static void save (const rw::trajectory::Transform3DPath &path, const std::string &filename)
 Saves rw::trajectory::Transform3DPath path to file. More...
 
static void save (const rw::trajectory::StatePath &path, const std::string &filename)
 Saves rw::trajectory::StatePath to file. More...
 
static void save (const rw::trajectory::TimedQPath &path, const std::string &filename)
 Saves rw::trajectory::TimedQPath to file. More...
 
static void save (const rw::trajectory::TimedStatePath &path, const std::string &filename)
 Saves rw::trajectory::TimedStatePath to file. More...
 
static void write (const rw::trajectory::QPath &path, std::ostream &outstream)
 Writes the rw::trajectory::QPath path to outstream. More...
 
static void write (const rw::trajectory::Vector3DPath &path, std::ostream &outstream)
 Writes rw::trajectory::Vector3DPath path to outstream. More...
 
static void write (const rw::trajectory::Rotation3DPath &path, std::ostream &outstream)
 Writes rw::trajectory::Rotation3DPath path to outstream. More...
 
static void write (const rw::trajectory::Transform3DPath &path, std::ostream &outstream)
 Writes rw::trajectory::Rotation3DPath path to outstream. More...
 
static void write (const rw::trajectory::StatePath &path, std::ostream &outstream)
 Writes rw::trajectory::Rotation3DPath path to outstream. More...
 
static void write (const rw::trajectory::TimedQPath &path, std::ostream &outstream)
 Writes rw::trajectory::Rotation3DPath path to outstream. More...
 
static void write (const rw::trajectory::TimedStatePath &path, std::ostream &outstream)
 Writes rw::trajectory::Rotation3DPath path to outstream. More...
 
static rw::core::DOMElem::Ptr createTransform3DPath (const rw::trajectory::Transform3DPath &path, rw::core::DOMElem::Ptr doc)
 Creates a DOMElem to represent path. More...
 
static rw::core::DOMElem::Ptr createQPath (const rw::trajectory::QPath &path, rw::core::DOMElem::Ptr doc)
 Creates a DOMElem to represent path. More...
 

Detailed Description

Class used for saving a Path using the RobWork XML Path Format.

Specification of the XML-format can be found in rwxml_path.xsd and matching with XMLPathLoader

Member Function Documentation

◆ createQPath()

static rw::core::DOMElem::Ptr createQPath ( const rw::trajectory::QPath path,
rw::core::DOMElem::Ptr  doc 
)
static

Creates a DOMElem to represent path.

Creates a DOMElement owned by doc and representing path

Parameters
path[in] path to represent
doc[in] Document which should contain the element
Returns
Pointer to the newly created DOMElem

◆ createTransform3DPath()

static rw::core::DOMElem::Ptr createTransform3DPath ( const rw::trajectory::Transform3DPath path,
rw::core::DOMElem::Ptr  doc 
)
static

Creates a DOMElem to represent path.

Creates a DOMElement owned by doc and representing path

Parameters
path[in] path to represent
doc[in] Document which should contain the element
Returns
Pointer to the newly created DOMElem

◆ save() [1/7]

static void save ( const rw::trajectory::QPath path,
const std::string &  filename 
)
static

Saves the rw::trajectory::QPath path to file.

If an error occurs while saving a rw::core::Exception is thrown

Parameters
path[in] Path to save
filename[in] Target filename

◆ save() [2/7]

static void save ( const rw::trajectory::Rotation3DPath path,
const std::string &  filename 
)
static

Saves rw::trajectory::Rotation3DPath path to file.

If an error occurs while saving a rw::core::Exception is thrown

Parameters
path[in] Path to save
filename[in] Target filename

◆ save() [3/7]

static void save ( const rw::trajectory::StatePath path,
const std::string &  filename 
)
static

Saves rw::trajectory::StatePath to file.

If an error occurs while saving a rw::core::Exception is thrown

Parameters
path[in] Path to save
filename[in] Target filename

◆ save() [4/7]

static void save ( const rw::trajectory::TimedQPath path,
const std::string &  filename 
)
static

Saves rw::trajectory::TimedQPath to file.

If an error occurs while saving a rw::core::Exception is thrown

Parameters
path[in] Path to save
filename[in] Target filename

◆ save() [5/7]

static void save ( const rw::trajectory::TimedStatePath path,
const std::string &  filename 
)
static

Saves rw::trajectory::TimedStatePath to file.

If an error occurs while saving a rw::core::Exception is thrown

Parameters
path[in] Path to save
filename[in] Target filename

◆ save() [6/7]

static void save ( const rw::trajectory::Transform3DPath path,
const std::string &  filename 
)
static

Saves rw::trajectory::Transform3DPath path to file.

If an error occurs while saving a rw::core::Exception is thrown

Parameters
path[in] Path to save
filename[in] Target filename

◆ save() [7/7]

static void save ( const rw::trajectory::Vector3DPath path,
const std::string &  filename 
)
static

Saves rw::trajectory::Vector3DPath path to file.

If an error occurs while saving a rw::core::Exception is thrown

Parameters
path[in] Path to save
filename[in] Target filename

◆ write() [1/7]

static void write ( const rw::trajectory::QPath path,
std::ostream &  outstream 
)
static

Writes the rw::trajectory::QPath path to outstream.

If an error occurs while saving a rw::core::Exception is thrown

Parameters
path[in] Path to save
outstream[in] Stream to write to

◆ write() [2/7]

static void write ( const rw::trajectory::Rotation3DPath path,
std::ostream &  outstream 
)
static

Writes rw::trajectory::Rotation3DPath path to outstream.

If an error occurs while saving a rw::core::Exception is thrown

Parameters
path[in] Path to save
outstream[in] Stream to write to

◆ write() [3/7]

static void write ( const rw::trajectory::StatePath path,
std::ostream &  outstream 
)
static

Writes rw::trajectory::Rotation3DPath path to outstream.

If an error occurs while saving a rw::core::Exception is thrown

Parameters
path[in] Path to save
outstream[in] Stream to write to

◆ write() [4/7]

static void write ( const rw::trajectory::TimedQPath path,
std::ostream &  outstream 
)
static

Writes rw::trajectory::Rotation3DPath path to outstream.

If an error occurs while saving a rw::core::Exception is thrown

Parameters
path[in] Path to save
outstream[in] Stream to write to

◆ write() [5/7]

static void write ( const rw::trajectory::TimedStatePath path,
std::ostream &  outstream 
)
static

Writes rw::trajectory::Rotation3DPath path to outstream.

If an error occurs while saving a rw::core::Exception is thrown

Parameters
path[in] Path to save
outstream[in] Stream to write to

◆ write() [6/7]

static void write ( const rw::trajectory::Transform3DPath path,
std::ostream &  outstream 
)
static

Writes rw::trajectory::Rotation3DPath path to outstream.

If an error occurs while saving a rw::core::Exception is thrown

Parameters
path[in] Path to save
outstream[in] Stream to write to

◆ write() [7/7]

static void write ( const rw::trajectory::Vector3DPath path,
std::ostream &  outstream 
)
static

Writes rw::trajectory::Vector3DPath path to outstream.

If an error occurs while saving a rw::core::Exception is thrown

Parameters
path[in] Path to save8
outstream[in] Stream to write to

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