Public Types | Public Member Functions | Protected Member Functions | Private Member Functions
XmlElement Class Reference

A pure virtual base class of XML element wrapper. More...

#include <XmlElement.h>

Inheritance diagram for XmlElement:
Inheritance graph
[legend]
Collaboration diagram for XmlElement:
Collaboration graph
[legend]

List of all members.

Public Types

typedef std::list< XmlElement * > NodeList_t
 The type of container used to store XmlElement nodes.

Public Member Functions

virtual void appendChild (const XmlNode &child)=0
 Appends a child element to the element.
virtual bool attribute (const std::string &name, bool &value) const =0
 Sets value to the attribute name's value.
virtual bool attribute (const std::string &name, double &value) const =0
 Sets value to the attribute name's value.
virtual bool attribute (const std::string &name, std::string &value) const =0
 Sets value to the attribute name's value.
virtual bool attribute (const std::string &name, int &value) const =0
 Sets value to the attribute name's value.
virtual bool attribute (const std::string &name, unsigned int &value) const =0
 Sets value to the attribute name's value.
virtual bool attribute (const std::string &name, float &value) const =0
 Sets value to the attribute name's value.
virtual void fillNodeList (const std::string &tagName, std::list< XmlElement * > &nodeList) const =0
 Fills the nodeList with elements with tag name tagName.
virtual int getID () const =0
 Returns the ID of the element, if it has one.
virtual XmlElementgetNode (const std::string &tagName) const =0
 Returns the single direct child element node with name tagName.
virtual const std::string & getText () const =0
 Gets the text node from the element.
virtual void setAttribute (const std::string &name, unsigned int value)=0
 Sets attribute named name to the unsigned int value value.
virtual void setAttribute (const std::string &name, const std::string &value)=0
 Sets attribute named name to the string value value.
virtual void setAttribute (const std::string &name, int value)=0
 Sets attribute named name to the int value value.
virtual void setAttribute (const std::string &name, float value)=0
 Sets attribute named name to the float value value.
virtual void setAttribute (const std::string &name, double value)=0
 Sets attribute named name to the double value value.
virtual void setAttribute (const std::string &name, bool value)=0
 Sets attribute named name to the int value value.
virtual std::string tagName () const =0
 Returns the tag name of the element.
virtual ~XmlElement ()
 The destructor.

Protected Member Functions

 XmlElement ()
 The default constructor.

Private Member Functions

 XmlElement (const XmlElement &)
 A private copy constructor in order to avoid copying.

Detailed Description

A pure virtual base class of XML element wrapper.

A derived class must implement the pure virtual functions probably using an external XML package.

Author:
Paul F. Kunz <Paul_Kunz@slac.stanford.edu>

Definition at line 30 of file XmlElement.h.


Member Typedef Documentation

typedef std::list< XmlElement * > NodeList_t

The type of container used to store XmlElement nodes.

Definition at line 47 of file XmlElement.h.


Constructor & Destructor Documentation

XmlElement ( const XmlElement ) [private]

A private copy constructor in order to avoid copying.

XmlElement ( ) [protected]

The default constructor.

Definition at line 16 of file XmlElement.cxx.

~XmlElement ( ) [virtual]

The destructor.

Definition at line 20 of file XmlElement.cxx.


Member Function Documentation

virtual void appendChild ( const XmlNode child) [pure virtual, inherited]
virtual bool attribute ( const std::string &  name,
bool &  value 
) const [pure virtual]
virtual bool attribute ( const std::string &  name,
std::string &  value 
) const [pure virtual]

Sets value to the attribute name's value.

If attribute of name name exists returns true, otherwise does not change value and returns false.

Implemented in QtXmlElement.

virtual bool attribute ( const std::string &  name,
int &  value 
) const [pure virtual]

Sets value to the attribute name's value.

If attribute of name name exists returns true, otherwise does not change value and returns false.

Implemented in QtXmlElement.

virtual bool attribute ( const std::string &  name,
double &  value 
) const [pure virtual]

Sets value to the attribute name's value.

If attribute of name name exists returns true, otherwise does not change value and returns false.

Implemented in QtXmlElement.

virtual bool attribute ( const std::string &  name,
unsigned int &  value 
) const [pure virtual]

Sets value to the attribute name's value.

If attribute of name name exists returns true, otherwise does not change value and returns false.

Implemented in QtXmlElement.

virtual bool attribute ( const std::string &  name,
float &  value 
) const [pure virtual]

Sets value to the attribute name's value.

If attribute of name name exists returns true, otherwise does not change value and returns false.

Implemented in QtXmlElement.

virtual void fillNodeList ( const std::string &  tagName,
std::list< XmlElement * > &  nodeList 
) const [pure virtual]

Fills the nodeList with elements with tag name tagName.

Implemented in QtXmlElement.

Referenced by BaseXML::fillNodeList(), PlotterBaseXML::getCutTargets(), and NTupleXML::getObject().

virtual int getID ( ) const [pure virtual]
virtual XmlElement* getNode ( const std::string &  tagName) const [pure virtual]

Returns the single direct child element node with name tagName.

If a child of that name doesn't exist returns a null pointer. if child exists but is not an element node, an assertion is made.

Implemented in QtXmlElement.

Referenced by DataRepXML::createObject(), BaseXML::getNode(), PlotterBaseXML::handleFunction(), and PlotterBaseXML::handleTextPlotter().

virtual const std::string& getText ( ) const [pure virtual]

Gets the text node from the element.

Implemented in QtXmlElement.

virtual void setAttribute ( const std::string &  name,
float  value 
) [pure virtual]

Sets attribute named name to the float value value.

Implemented in QtXmlElement.

virtual void setAttribute ( const std::string &  name,
unsigned int  value 
) [pure virtual]

Sets attribute named name to the unsigned int value value.

Implemented in QtXmlElement.

virtual void setAttribute ( const std::string &  name,
double  value 
) [pure virtual]

Sets attribute named name to the double value value.

Implemented in QtXmlElement.

virtual void setAttribute ( const std::string &  name,
const std::string &  value 
) [pure virtual]

Sets attribute named name to the string value value.

Implemented in QtXmlElement.

virtual void setAttribute ( const std::string &  name,
bool  value 
) [pure virtual]
virtual void setAttribute ( const std::string &  name,
int  value 
) [pure virtual]

Sets attribute named name to the int value value.

Implemented in QtXmlElement.

virtual std::string tagName ( ) const [pure virtual]

Returns the tag name of the element.

This function is not needed for XML processing. It is only here as an aid in debugging.

Implemented in QtXmlElement.


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

Generated for HippoDraw Class Library by doxygen