Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
BinsBaseXML Class Reference

A class XML creation and parsing of XmlElement for BinsBase class. More...

#include <BinsBaseXML.h>

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

List of all members.

Public Member Functions

 BinsBaseXML (XmlController *)
 A default constructor for avoiding creation except by itself or with derived classes.
XmlElementcreateElement (const BinsBase &bins)
 Returns a newly created XmlElement with attributes set for view.
XmlElementcreateElement ()
 Creates a new element node.
virtual BinsBasecreateObject (const XmlElement *element)
 Creates an object derived from BinsBaseBase.
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.
 ~BinsBaseXML ()
 The destructor.

Protected Types

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

Protected Member Functions

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

 BinsBaseXML (const BinsBaseXML &)
 A private copy constructor in order to avoid copying.
void createChildren (XmlElement &tag, const BinsBase &bins)
 Creates the child XML elements of this element.

Private Attributes

std::string m_axis
 The attribute name for the axis of the BinnerAxisXML element.
BinnerAxisXMLm_binnerXML
 The BinsBaseXML object used by this object.

Detailed Description

A class XML creation and parsing of XmlElement for BinsBase class.

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

Definition at line 29 of file BinsBaseXML.h.


Member Typedef Documentation

typedef std::list< XmlElement * > NodeList_t [protected, inherited]

The container type for element nodes.

Definition at line 47 of file BaseXML.h.


Constructor & Destructor Documentation

BinsBaseXML ( XmlController controller)

A default constructor for avoiding creation except by itself or with derived classes.

Definition at line 32 of file BinsBaseXML.cxx.

References BinsBaseXML::m_binnerXML.

The destructor.

Definition at line 40 of file BinsBaseXML.cxx.

References BinsBaseXML::m_binnerXML.

BinsBaseXML ( const BinsBaseXML ) [private]

A private copy constructor in order to avoid copying.


Member Function Documentation

void createChildren ( XmlElement tag,
const BinsBase bins 
) [private]
XmlElement * createElement ( const BinsBase bins)

Returns a newly created XmlElement with attributes set for view.

Definition at line 47 of file BinsBaseXML.cxx.

References BinsBaseXML::createChildren(), BaseXML::createElement(), BaseXML::m_type, BinsBase::name(), XmlElement::setAttribute(), and num_util::type().

Referenced by BinningProjectorXML::createChildren().

XmlElement * createElement ( ) [inherited]
BinsBase * createObject ( const XmlElement element) [virtual]
void fillNodeList ( const XmlElement element,
std::list< XmlElement * > &  nodelist 
) [inherited]
const XmlElement * getNode ( const XmlElement element) const [inherited]

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(), PlotterBaseXML::getObject(), BinningProjectorXML::getObject(), ViewBaseXML::getObjects(), and BinningProjectorXML::setBins().

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

Returns the tag name used by this class.

Definition at line 48 of file BaseXML.cxx.

References BaseXML::m_tagname.


Member Data Documentation

std::string m_axis [private]

The attribute name for the axis of the BinnerAxisXML element.

Definition at line 35 of file BinsBaseXML.h.

Referenced by BinsBaseXML::createChildren(), and BinsBaseXML::createObject().

The BinsBaseXML object used by this object.

Definition at line 38 of file BinsBaseXML.h.

Referenced by BinsBaseXML::BinsBaseXML(), BinsBaseXML::createChildren(), BinsBaseXML::createObject(), and BinsBaseXML::~BinsBaseXML().

XmlController* m_controller [protected, inherited]
const std::string m_id [protected, inherited]

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, inherited]

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, inherited]

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

Generated for HippoDraw Class Library by doxygen