hpp::manipulation::parser::ObjectFactory Class Reference

Class that catch XML Parser events for a specific tag and build the corresponding Object. More...

#include <hpp/manipulation/parser/parser.hh>

Inheritance diagram for hpp::manipulation::parser::ObjectFactory:

List of all members.

Public Types

typedef std::list
< ObjectFactory * > 
ObjectFactoryList

Public Member Functions

 ObjectFactory (ObjectFactory *parent=NULL, const XMLElement *element=NULL)
void name (const std::string &n)
 Set the name.
void name (const char *n)
 See name(const std::string&)
template<typename T >
T * as ()
 Cast this class to any child class.
Events
virtual bool init ()
 Called when the object is created.
void setAttribute (const XMLAttribute *attr)
 Called for each attribute.
virtual void addTextChild (const XMLText *text)
 Add Text child.
virtual bool finishAttributes ()
 Called when all the attributes have been processed.
virtual void finishTags ()
 Called when all the child tags have been processed.
virtual void finishFile ()
 Called when parsing is finished.
Accessors
std::string tagName () const
 Return tag name of the element is any.
std::string name () const
 Return the content of the attribute name, or an empty string.
bool hasAttribute (const std::string &attr) const
 Check if an attribute was set.
std::string getAttribute (const std::string &attr) const
 Return a given attributes.
ObjectFactoryList getChildrenOfType (std::string type)
 Get a list of ObjectFactory whose tag name is type.
bool getChildOfType (std::string type, ObjectFactory *&o)
 Get the ObjectFactory whose tag name is type.

Protected Member Functions

 ObjectFactory (RootFactory *root)
ObjectFactoryparent ()
RootFactoryroot ()
bool hasParent () const
const XMLElementXMLelement ()
virtual void impl_setAttribute (const XMLAttribute *attr)
void addChild (ObjectFactory *child)
virtual std::ostream & print (std::ostream &os) const

Friends

std::ostream & operator<< (std::ostream &, const ObjectFactory &)

Detailed Description

Class that catch XML Parser events for a specific tag and build the corresponding Object.

Derive this class if you wish to extend the Parser. The event callbacks are called in the following order:

Note:
The derived class must have the following construtor
 DerivedFactory (ObjectFactory* parent, const XMLElement* element) :
       ObjectFactory (parent, element)
 {
   /*
 Keep in mind that it might be more convenient
 to build objects in an event callback, when some information
 has already been parsed.
    */
 }

Member Typedef Documentation


Constructor & Destructor Documentation

hpp::manipulation::parser::ObjectFactory::ObjectFactory ( ObjectFactory parent = NULL,
const XMLElement element = NULL 
)
hpp::manipulation::parser::ObjectFactory::ObjectFactory ( RootFactory root) [protected]

Member Function Documentation

void hpp::manipulation::parser::ObjectFactory::addChild ( ObjectFactory child) [protected]
virtual void hpp::manipulation::parser::ObjectFactory::addTextChild ( const XMLText text) [virtual]
template<typename T >
T* hpp::manipulation::parser::ObjectFactory::as ( ) [inline]

Cast this class to any child class.

virtual bool hpp::manipulation::parser::ObjectFactory::finishAttributes ( ) [virtual]

Called when all the attributes have been processed.

Returns:
True to continue parsing this tag, False otherwise.
virtual void hpp::manipulation::parser::ObjectFactory::finishFile ( ) [virtual]

Called when parsing is finished.

virtual void hpp::manipulation::parser::ObjectFactory::finishTags ( ) [virtual]

Called when all the child tags have been processed.

Reimplemented in hpp::manipulation::srdf::ContactFactory, and hpp::manipulation::srdf::GripperFactory.

std::string hpp::manipulation::parser::ObjectFactory::getAttribute ( const std::string &  attr) const

Return a given attributes.

bool hpp::manipulation::parser::ObjectFactory::getChildOfType ( std::string  type,
ObjectFactory *&  o 
)

Get the ObjectFactory whose tag name is type.

Parameters:
[out]oSet to the first element of the requested type.
Returns:
true if there was only element of the requested type. false if there are more than one.
Exceptions:
std::invalid_argumentif no ObjectFactory of the requested type exists.
ObjectFactoryList hpp::manipulation::parser::ObjectFactory::getChildrenOfType ( std::string  type)

Get a list of ObjectFactory whose tag name is type.

bool hpp::manipulation::parser::ObjectFactory::hasAttribute ( const std::string &  attr) const

Check if an attribute was set.

bool hpp::manipulation::parser::ObjectFactory::hasParent ( ) const [protected]
virtual void hpp::manipulation::parser::ObjectFactory::impl_setAttribute ( const XMLAttribute attr) [protected, virtual]
virtual bool hpp::manipulation::parser::ObjectFactory::init ( ) [virtual]

Called when the object is created.

Returns:
True to continue parsing this tag, False otherwise.

Reimplemented in hpp::manipulation::parser::IgnoreTagFactory.

std::string hpp::manipulation::parser::ObjectFactory::name ( ) const

Return the content of the attribute name, or an empty string.

void hpp::manipulation::parser::ObjectFactory::name ( const std::string &  n)

Set the name.

The default value is the value of the attribute "name" of the XML tag or an empty string if this does not exist.

void hpp::manipulation::parser::ObjectFactory::name ( const char *  n)
ObjectFactory* hpp::manipulation::parser::ObjectFactory::parent ( ) [protected]
virtual std::ostream& hpp::manipulation::parser::ObjectFactory::print ( std::ostream &  os) const [protected, virtual]
RootFactory* hpp::manipulation::parser::ObjectFactory::root ( ) [protected]
void hpp::manipulation::parser::ObjectFactory::setAttribute ( const XMLAttribute attr)

Called for each attribute.

A few reserved name are automatocally catched. The reserved names are "name" and "id". "name" expects a string. "id" expects an unsigned integer and can be use to define pointers to elements.

std::string hpp::manipulation::parser::ObjectFactory::tagName ( ) const

Return tag name of the element is any.

Returns "No element" otherwise.

const XMLElement* hpp::manipulation::parser::ObjectFactory::XMLelement ( ) [protected]

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  ,
const ObjectFactory  
) [friend]