openrave.org

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
OpenRAVE::BaseXMLWriter Class Referenceabstract

base class for writing to XML files. More...

#include <openrave.h>

Inheritance diagram for OpenRAVE::BaseXMLWriter:
Inheritance graph
[legend]
Collaboration diagram for OpenRAVE::BaseXMLWriter:
Collaboration graph
[legend]

Public Member Functions

virtual ~BaseXMLWriter ()
 
virtual const std::string & GetFormat () const =0
 return the format for the data writing, should be all lower capitals.
 
virtual void SetCharData (const std::string &data)=0
 saves character data to the child. Special characters like '<' are automatically converted to fit inside XML.
 
virtual BaseXMLWriterPtr AddChild (const std::string &xmltag, const AttributesList &atts=AttributesList())=0
 returns a writer for child elements
 

Detailed Description

base class for writing to XML files.

OpenRAVE Interfaces accept a BaseXMLWriter instance and call its write methods to write the data.

Definition at line 784 of file openrave.h.

Constructor & Destructor Documentation

virtual OpenRAVE::BaseXMLWriter::~BaseXMLWriter ( )
inlinevirtual

Definition at line 787 of file openrave.h.

Member Function Documentation

virtual BaseXMLWriterPtr OpenRAVE::BaseXMLWriter::AddChild ( const std::string &  xmltag,
const AttributesList atts = AttributesList() 
)
pure virtual

returns a writer for child elements

Implemented in OpenRAVE::xmlreaders::StreamXMLWriter.

virtual const std::string& OpenRAVE::BaseXMLWriter::GetFormat ( ) const
pure virtual

return the format for the data writing, should be all lower capitals.

Samples formats are 'openrave', 'collada'

Implemented in OpenRAVE::xmlreaders::StreamXMLWriter.

virtual void OpenRAVE::BaseXMLWriter::SetCharData ( const std::string &  data)
pure virtual

saves character data to the child. Special characters like '<' are automatically converted to fit inside XML.

Exceptions
openrave_exceptionthrows if this element cannot have character data or the character data was not written

Implemented in OpenRAVE::xmlreaders::StreamXMLWriter.


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