Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
BaseXML Class Reference

A base class of XML element controllers. More...

#include <BaseXML.h>

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

Public Member Functions

XmlElementcreateElement ()
 Creates a new element node.
void fillNodeList (const XmlElement *element, std::list< XmlElement * > &nodelist)
 Fills the nodelist with immediate child nodes of element with nodes that can be handled by this object.
const XmlElementgetNode (const XmlElement *element) const
 Returns the single child node of element of the type that can be handled by this object.
virtual const std::string & tagName () const
 Returns the tag name used by this class.
virtual ~BaseXML ()
 The destructor.

Protected Types

typedef std::list< XmlElement * > NodeList_t
 The container type for element nodes.

Protected Member Functions

 BaseXML (const std::string &tagname, XmlController *)
 A constructor that takes the tag name and XML controller object as arguments.
void setId (XmlElement &tag, int id)
 Sets the unique identification of the object.

Protected Attributes

XmlControllerm_controller
 The singleton XML controller object.
const std::string m_id
 The attribute name for the identification of the object.
const std::string m_tagname
 The tag name used for elements created by this class.
const std::string m_type
 The attribute name for the type of object.

Private Member Functions

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

Detailed Description

A base class of XML element controllers.

Its purpose is to provide consistency in naming convention of the generated XML files across possible concrete XML controllers.

Author
Paul F. Kunz Paul_.nosp@m.Kunz.nosp@m.@slac.nosp@m..sta.nosp@m.nford.nosp@m..edu

Definition at line 35 of file BaseXML.h.

Member Typedef Documentation

typedef std::list< XmlElement * > NodeList_t
protected

The container type for element nodes.

Definition at line 47 of file BaseXML.h.

Constructor & Destructor Documentation

BaseXML ( const BaseXML )
private

A private copy constructor in order to avoid copying.

BaseXML ( const std::string &  tagname,
XmlController controller 
)
protected

A constructor that takes the tag name and XML controller object as arguments.

Since a default constructor does not exist, derived class must use this constructor therefore guaranteeing that the tag name is always set by derived classes.

Definition at line 31 of file BaseXML.cxx.

~BaseXML ( )
virtual

The destructor.

Definition at line 39 of file BaseXML.cxx.

Member Function Documentation

XmlElement * createElement ( )
void fillNodeList ( const XmlElement element,
std::list< XmlElement * > &  nodelist 
)
const XmlElement * getNode ( const XmlElement element) const

Returns the single child node of element of the type that can be handled by this object.

If no such node exists, returns a null pointer.

Definition at line 53 of file BaseXML.cxx.

References XmlElement::getNode(), and BaseXML::m_tagname.

Referenced by PointRepXML::createObject(), DataRepXML::createObject(), BinningProjectorXML::getObject(), PlotterBaseXML::getObject(), ViewBaseXML::getObjects(), and BinningProjectorXML::setBins().

void setId ( XmlElement tag,
int  id 
)
protected
const string & tagName ( ) const
virtual

Returns the tag name used by this class.

Definition at line 48 of file BaseXML.cxx.

References BaseXML::m_tagname.

Member Data Documentation

XmlController* m_controller
protected
const std::string m_id
protected

The attribute name for the identification of the object.

Definition at line 57 of file BaseXML.h.

Referenced by BaseXML::setId().

const std::string m_tagname
protected

The tag name used for elements created by this class.

Definition at line 50 of file BaseXML.h.

Referenced by BaseXML::createElement(), BaseXML::fillNodeList(), BaseXML::getNode(), and BaseXML::tagName().

const std::string m_type
protected

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

Generated for HippoDraw Class Library by doxygen