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

BinnerAxisXML Class Reference

#include <BinnerAxisXML.h>

Inheritance diagram for BinnerAxisXML:

Inheritance graph
[legend]
Collaboration diagram for BinnerAxisXML:

Collaboration graph
[legend]
List of all members.

Detailed Description

A class XML creation and parsing of XmlElement for BinnerAxis classes.

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

Definition at line 24 of file BinnerAxisXML.h.

Public Member Functions

 BinnerAxisXML (XmlController *)
 A default constructor for avoiding creation except by itself or with derived classes.
XmlElement * createElement ()
 Creates a new element node.
XmlElement * createElement (const BinnerAxis &binner)
 Returns a newly created XmlElement with attributes set for binner.
virtual BinnerAxis * createObject (const XmlElement *element)
 Creates an object derived from BinnerAxis.
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

 BinnerAxisXML (const BinnerAxisXML &)
 A private copy constructor in order to avoid copying.
void setAttributes (XmlElement *tag, const BinnerAxis &binner)
 Sets the attributes of the elment.

Private Attributes

std::string m_high
 The attribute name for the high end of the binner's Range.
std::string m_low
 The attribute name for the low end of the binner's Range.
std::string m_width
 The attribute name for the width parameter of the binner.

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

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

A private copy constructor in order to avoid copying.

BinnerAxisXML::BinnerAxisXML (  XmlController *   ) 
 

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

Definition at line 28 of file BinnerAxisXML.cxx.

Member Function Documentation

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(), BinsBaseXML::createElement(), BinningProjectorXML::createElement(), createElement(), PlotterBaseXML::createFontElement(), and PlotterBaseXML::createFontElements().

XmlElement * BinnerAxisXML::createElement (  const BinnerAxis &  binner  ) 
 

Returns a newly created XmlElement with attributes set for binner.

Definition at line 38 of file BinnerAxisXML.cxx.

References BaseXML::createElement(), and setAttributes().

Referenced by BinsBaseXML::createChildren().

BinnerAxis * BinnerAxisXML::createObject (  const XmlElement *  element  )  [virtual]
 

Creates an object derived from BinnerAxis.

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

Definition at line 66 of file BinnerAxisXML.cxx.

References XmlElement::attribute(), Factory< Type >::create(), BinnerAxisFactory::instance(), m_high, m_low, BaseXML::m_type, m_width, BinnerAxis::setBinWidth(), BinnerAxis::setRange(), and num_util::type().

Referenced by BinsBaseXML::createObject().

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(), BinsBaseXML::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 BinnerAxisXML::setAttributes (  XmlElement *  tag,
const BinnerAxis &  binner
)  [private]
 

Sets the attributes of the elment.

Definition at line 48 of file BinnerAxisXML.cxx.

References BinnerAxis::getBinWidth(), BinnerAxis::getRange(), Range::high(), Range::low(), m_high, m_low, BaseXML::m_type, m_width, BinnerAxis::name(), XmlElement::setAttribute(), and num_util::type().

Referenced by createElement().

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

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().

std::string BinnerAxisXML::m_high [private]
 

The attribute name for the high end of the binner's Range.

Definition at line 36 of file BinnerAxisXML.h.

Referenced by createObject(), and 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().

std::string BinnerAxisXML::m_low [private]
 

The attribute name for the low end of the binner's Range.

Definition at line 39 of file BinnerAxisXML.h.

Referenced by createObject(), and setAttributes().

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(), BinsBaseXML::createElement(), TransformXML::createObject(), PointRepXML::createObject(), DataRepXML::createObject(), BinToColorXML::createObject(), BinsBaseXML::createObject(), createObject(), PlotterBaseXML::createPlotter(), PointRepXML::setAttributes(), and setAttributes().

std::string BinnerAxisXML::m_width [private]
 

The attribute name for the width parameter of the binner.

Definition at line 33 of file BinnerAxisXML.h.

Referenced by createObject(), and setAttributes().

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