openrave.org

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

base class for all xml readers. XMLReaders are used to process data from xml files. More...

#include <openrave.h>

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

Public Types

enum  ProcessElement { PE_Pass =0, PE_Support =1, PE_Ignore =2 }
 

Public Member Functions

 BaseXMLReader ()
 
virtual ~BaseXMLReader ()
 
virtual XMLReadablePtr GetReadable ()
 
virtual ProcessElement startElement (const std::string &name, const AttributesList &atts)=0
 
virtual bool endElement (const std::string &name)=0
 
virtual void characters (const std::string &ch)=0
 

Public Attributes

std::string _filename
 XML filename/resource used for this class (can be empty)
 

Detailed Description

base class for all xml readers. XMLReaders are used to process data from xml files.

Custom readers can be registered through RaveRegisterXMLReader.

Examples:
customreader.cpp.

Definition at line 719 of file openrave.h.

Member Enumeration Documentation

Enumerator:
PE_Pass 

current tag was not supported, so pass onto another class

PE_Support 

current tag will be processed by this class

PE_Ignore 

current tag and all its children should be ignored

Definition at line 722 of file openrave.h.

Constructor & Destructor Documentation

OpenRAVE::BaseXMLReader::BaseXMLReader ( )
inline

Definition at line 728 of file openrave.h.

virtual OpenRAVE::BaseXMLReader::~BaseXMLReader ( )
inlinevirtual

Definition at line 730 of file openrave.h.

Member Function Documentation

virtual void OpenRAVE::BaseXMLReader::characters ( const std::string &  ch)
pure virtual
virtual bool OpenRAVE::BaseXMLReader::endElement ( const std::string &  name)
pure virtual
virtual XMLReadablePtr OpenRAVE::BaseXMLReader::GetReadable ( )
inlinevirtual

a readable interface that stores the information processsed for the current tag This pointer is used to the InterfaceBase class registered readers

Reimplemented in OpenRAVE::SimpleSensorSystem::SimpleXMLReader, OpenRAVE::xmlreaders::HierarchicalXMLReader, and cppexamples::CustomController::PIDXMLReader.

Definition at line 735 of file openrave.h.

virtual ProcessElement OpenRAVE::BaseXMLReader::startElement ( const std::string &  name,
const AttributesList atts 
)
pure virtual

Member Data Documentation

std::string OpenRAVE::BaseXMLReader::_filename

XML filename/resource used for this class (can be empty)

Definition at line 755 of file openrave.h.


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