Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

BinsBaseXML Class Reference

#include <BinsBaseXML.h>

Inheritance diagram for BinsBaseXML:

Inheritance graph
[legend]
Collaboration diagram for BinsBaseXML:

Collaboration graph
[legend]
List of all members.

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 25 of file BinsBaseXML.h.

Public Member Functions

 BinsBaseXML (XmlController *)
 A default constructor for avoiding creation except by itself or with derived classes.
XmlElement * createElement ()
 Creates a new element node.
XmlElement * createElement (const BinsBase &bins)
 Returns a newly created XmlElement with attributes set for view.
virtual BinsBase * createObject (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 XmlElement * getNode (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.

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

XmlController * m_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.
void createNTuple (XmlElement &tag, const BinsBase &bins)
 Creates a Dom Text node with the contents of bin.

Private Attributes

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

Member Typedef Documentation

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

The container type for element nodes.

Definition at line 45 of file BaseXML.h.

Constructor & Destructor Documentation

BinsBaseXML::BinsBaseXML (  XmlController *   ) 
 

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

Definition at line 32 of file BinsBaseXML.cxx.

References m_binnerXML.

BinsBaseXML::BinsBaseXML (  const BinsBaseXML &   )  [private]
 

A private copy constructor in order to avoid copying.

Member Function Documentation

void BinsBaseXML::createChildren (  XmlElement &  tag,
const BinsBase &  bins
)  [private]
 

Creates the child XML elements of this element.

Definition at line 55 of file BinsBaseXML.cxx.

References XmlNode::appendChild(), BinnerAxisXML::createElement(), BinsBase::getBinnerOn(), BinsBase::getNumberOfAxes(), m_axis, m_binnerXML, XmlElement::setAttribute(), hippodraw::Axes::X, and hippodraw::Axes::Y.

Referenced by createElement().

XmlElement * BaseXML::createElement (   )  [inherited]
 

Creates a new element node.

Uses the current document as determined by the XMLController.

Definition at line 41 of file BaseXML.cxx.

References XmlDocument::createElement(), BaseXML::m_tagname, and XmlController::m_xml_doc.

Referenced by PlotterBaseXML::createAxisModel(), DataRepXML::createChildren(), BinningProjectorXML::createChildren(), AxisModelXML::createChildren(), NTupleXML::createChildren2D(), PlotterBaseXML::createCutChildren(), ViewBaseXML::createElement(), TupleCutXML::createElement(), TransformXML::createElement(), PointRepXML::createElement(), PlotterBaseXML::createElement(), NTupleXML::createElement(), NTupleProjectorXML::createElement(), MapMatrixProjectorXML::createElement(), HiNTupleXML::createElement(), FunctionProjectorXML::createElement(), DataRepXML::createElement(), ColorXML::createElement(), BinToColorXML::createElement(), createElement(), BinningProjectorXML::createElement(), BinnerAxisXML::createElement(), PlotterBaseXML::createFontElement(), and PlotterBaseXML::createFontElements().

XmlElement * BinsBaseXML::createElement (  const BinsBase &  bins  ) 
 

Returns a newly created XmlElement with attributes set for view.

Definition at line 41 of file BinsBaseXML.cxx.

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

Referenced by BinningProjectorXML::createChildren().

void BinsBaseXML::createNTuple (  XmlElement &  tag,
const BinsBase &  bins
)  [private]
 

Creates a Dom Text node with the contents of bin.

Definition at line 75 of file BinsBaseXML.cxx.

BinsBase * BinsBaseXML::createObject (  const XmlElement *  element  )  [virtual]
 

Creates an object derived from BinsBaseBase.

Uses the information in it to instantiate and return the object.

Definition at line 82 of file BinsBaseXML.cxx.

References XmlElement::attribute(), Factory< Type >::create(), BinnerAxisXML::createObject(), BaseXML::fillNodeList(), BinsFactory::instance(), m_axis, m_binnerXML, BaseXML::m_type, BinsBase::setBinnerOn(), num_util::type(), hippodraw::Axes::X, and hippodraw::Axes::Y.

Referenced by BinningProjectorXML::getObject().

void BaseXML::fillNodeList (  const XmlElement *  element,
std::list< XmlElement * > &  nodelist
)  [inherited]
 

Fills the nodelist with immediate child nodes of element with nodes that can be handled by this object.

Definition at line 56 of file BaseXML.cxx.

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

Referenced by ViewBaseXML::connectPlotters(), PlotterBaseXML::createAxisModels(), AxisModelXML::createChildren(), PlotterBaseXML::createFontObjects(), BinToColorXML::createObject(), createObject(), XmlController::getDataReps(), PlotterBaseXML::getObject(), TupleCutXML::getObjects(), XmlController::getTupleCuts(), XmlController::getViews(), XmlController::openNTuples(), and TupleCutXML::setAttributes().

const XmlElement * BaseXML::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 51 of file BaseXML.cxx.

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

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

void BaseXML::setId (  XmlElement &  tag,
int  id
)  [protected, inherited]
 

Sets the unique identification of the object.

Definition at line 62 of file BaseXML.cxx.

References BaseXML::m_id, and XmlElement::setAttribute().

Referenced by ViewBaseXML::createElement(), TupleCutXML::createElement(), PlotterBaseXML::createElement(), NTupleProjectorXML::createElement(), MapMatrixProjectorXML::createElement(), HiNTupleXML::createElement(), FunctionProjectorXML::createElement(), DataRepXML::createElement(), BinningProjectorXML::createElement(), PointRepXML::setAttributes(), and NTupleXML::setAttributes().

const string & BaseXML::tagName (   )  const [virtual, inherited]
 

Returns the tag name used by this class.

Definition at line 46 of file BaseXML.cxx.

References BaseXML::m_tagname.

Member Data Documentation

std::string BinsBaseXML::m_axis [private]
 

The attribute name for the axis of the BinnerAxisXML element.

Definition at line 31 of file BinsBaseXML.h.

Referenced by createChildren(), and createObject().

BinnerAxisXML* BinsBaseXML::m_binnerXML [private]
 

The BinsBaseXML object used by this object.

Definition at line 34 of file BinsBaseXML.h.

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

XmlController* BaseXML::m_controller [protected, inherited]
 

The singleton XML controller object.

Definition at line 58 of file BaseXML.h.

Referenced by NTupleProjectorXML::addCuts(), ViewBaseXML::connectPlotters(), NTupleProjectorXML::createChildren(), PlotterBaseXML::createCutChildren(), DataRepXML::createDataRep(), ViewBaseXML::createElement(), TupleCutXML::createElement(), PlotterBaseXML::createElement(), NTupleProjectorXML::createElement(), MapMatrixProjectorXML::createElement(), HiNTupleXML::createElement(), FunctionProjectorXML::createElement(), DataRepXML::createElement(), BinningProjectorXML::createElement(), PlotterBaseXML::createFontObjects(), DataRepXML::createFunctionTargetChild(), DataRepXML::createObject(), PlotterBaseXML::createPlotter(), PlotterBaseXML::createTextChildren(), PlotterBaseXML::getCutTargets(), PlotterBaseXML::getObject(), ViewBaseXML::getObjects(), PlotterBaseXML::handleCutPlotter(), PlotterBaseXML::handleFunction(), PlotterBaseXML::handleTextPlotter(), PointRepXML::setAttributes(), and NTupleXML::setAttributes().

const std::string BaseXML::m_id [protected, inherited]
 

The attribute name for the identification of the object.

Definition at line 55 of file BaseXML.h.

Referenced by BaseXML::setId().

const std::string BaseXML::m_tagname [protected, inherited]
 

The tag name used for elements created by this class.

Definition at line 48 of file BaseXML.h.

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

const std::string BaseXML::m_type [protected, inherited]
 

The attribute name for the type of object.

Used to create object from one of the classes derived from Factory.

Definition at line 52 of file BaseXML.h.

Referenced by DataRepXML::createDataRep(), TransformXML::createElement(), PlotterBaseXML::createElement(), DataRepXML::createElement(), BinToColorXML::createElement(), createElement(), TransformXML::createObject(), PointRepXML::createObject(), DataRepXML::createObject(), BinToColorXML::createObject(), createObject(), BinnerAxisXML::createObject(), PlotterBaseXML::createPlotter(), PointRepXML::setAttributes(), and BinnerAxisXML::setAttributes().

The documentation for this class was generated from the following files:
Generated for HippoDraw-1.14.8.5 by doxygen 1.4.3