OpenRAVE::BaseXMLReader Class Reference

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

#include <openrave.h>

Inheritance diagram for OpenRAVE::BaseXMLReader:

Collaboration diagram for OpenRAVE::BaseXMLReader:

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

enum OpenRAVE::BaseXMLReader::ProcessElement

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

gets called for all data in between tags.

Parameters

ch	a string to the data

Implemented in OpenRAVE::ConfigurationSpecification::Reader, OpenRAVE::DummyXMLReader, OpenRAVE::WorkspaceTrajectoryParameters, OpenRAVE::PlannerBase::PlannerParameters, OpenRAVE::SimpleSensorSystem::SimpleXMLReader, OpenRAVE::xmlreaders::HierarchicalXMLReader, OpenRAVE::xmlreaders::GeometryInfoReader, OpenRAVE::xmlreaders::TrajectoryReader, and cppexamples::CustomController::PIDXMLReader.

virtual bool OpenRAVE::BaseXMLReader::endElement ( const std::string &  name )

pure virtual

Gets called at the end of each "</type>" expression. In this case, name is "type"

Parameters

name	of the tag, will be always lower case

Returns

true if XMLReader has finished parsing (one condition is that name==_fieldname) , otherwise false

Implemented in OpenRAVE::ConfigurationSpecification::Reader, OpenRAVE::DummyXMLReader, OpenRAVE::BasicRRTParameters, OpenRAVE::RRTParameters, OpenRAVE::WorkspaceTrajectoryParameters, OpenRAVE::ConstraintTrajectoryTimingParameters, OpenRAVE::TrajectoryTimingParameters, OpenRAVE::GraspParameters, OpenRAVE::PlannerBase::PlannerParameters, OpenRAVE::GraspSetParameters, OpenRAVE::SimpleSensorSystem::SimpleXMLReader, OpenRAVE::RAStarParameters, OpenRAVE::xmlreaders::HierarchicalXMLReader, OpenRAVE::xmlreaders::GeometryInfoReader, OpenRAVE::ExplorationParameters, OpenRAVE::xmlreaders::TrajectoryReader, and cppexamples::CustomController::PIDXMLReader.

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

Gets called in the beginning of each "<type>" expression. In this case, name is "type"

Parameters

name	of the tag, will be always lower case
atts	string of attributes where the first std::string is the attribute name and second is the value

Returns

true if tag is accepted and this class will process it, otherwise false

Implemented in OpenRAVE::ConfigurationSpecification::Reader, OpenRAVE::DummyXMLReader, OpenRAVE::BasicRRTParameters, OpenRAVE::RRTParameters, OpenRAVE::WorkspaceTrajectoryParameters, OpenRAVE::ConstraintTrajectoryTimingParameters, OpenRAVE::TrajectoryTimingParameters, OpenRAVE::GraspParameters, OpenRAVE::PlannerBase::PlannerParameters, OpenRAVE::GraspSetParameters, OpenRAVE::SimpleSensorSystem::SimpleXMLReader, OpenRAVE::RAStarParameters, OpenRAVE::xmlreaders::HierarchicalXMLReader, OpenRAVE::xmlreaders::GeometryInfoReader, OpenRAVE::xmlreaders::TrajectoryReader, OpenRAVE::ExplorationParameters, and cppexamples::CustomController::PIDXMLReader.

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:

• /var/lib/jenkins/workspace/openrave_documentation/openrave/include/openrave/openrave.h (2013-03-18 10:33:00 +0900, commit:334d202)