NTupleXML Class Reference

#include <NTupleXML.h>

Inheritance diagram for NTupleXML:

[legend]Collaboration diagram for NTupleXML:

[legend]List of all members.

---

Detailed Description

A singleton class that is does XML serialization and deserialization of derived classes of NTuple.

Requests:

Need to save shape of NTuple in order to implement saving St2DHistogram.

Author:

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

Definition at line 33 of file NTupleXML.h.

Public Member Functions
XmlElement *	createElement ()
	Creates a new element node.
XmlElement *	createElement (const DataSource &ntuple)
	Returns a newly created XmlElement for DataSource.
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.
std::string	getName (const XmlElement &tag) const
	Returns the name of the NTuple 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.
const DataSource *	getObject (const XmlElement &tag)
	Returns the DataSource corresponding to XmlElement.
	NTupleXML (XmlController *)
	The only public constructor.
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
void	createChildren (XmlElement *tag, const DataSource &ntuple)
	Creates the Dom text node children.
void	createChildren2D (XmlElement *tag, const DataSource &ntuple)
	Creates the Dom text node children for 1D histograms.
void	createChildren3D (XmlElement *tag, const DataSource &ntuple)
	Creates the Dom text node children for 2D histograms.
	NTupleXML (const NTupleXML &)
	A private copy constructor in order to avoid copying.
void	setAttributes (XmlElement *tag, const DataSource &ntuple)
	Sets the attributes.
Private Attributes
std::string	m_col_name
	the attribute name for the column index.
std::string	m_data
	The tag name of the column data.
std::string	m_label
	The attribute name of the column label.
std::string	m_name
	The tag name for the name attribute.

---

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

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

A private copy constructor in order to avoid copying.

NTupleXML::NTupleXML (  XmlController *   )

The only public constructor. Definition at line 47 of file NTupleXML.cxx.

---

Member Function Documentation

void NTupleXML::createChildren (  XmlElement *  tag, const DataSource &  ntuple )  [private]

Creates the Dom text node children. Definition at line 84 of file NTupleXML.cxx. References DataSource::columns(), createChildren2D(), and hippodraw::DataPoint2DTuple::SIZE. Referenced by createElement().

void NTupleXML::createChildren2D (  XmlElement *  tag, const DataSource &  ntuple )  [private]

Creates the Dom text node children for 1D histograms. Definition at line 93 of file NTupleXML.cxx. References BaseXML::createElement(), num_util::data(), DataSource::getColumn(), DataSource::getLabelAt(), m_col_name, m_data, m_label, XmlController::m_xml_doc, DataSource::rows(), num_util::size(), hippodraw::DataPoint2DTuple::SIZE, hippodraw::Axes::X, hippodraw::DataPoint2DTuple::XERR, hippodraw::Axes::Y, and hippodraw::DataPoint2DTuple::YERR. Referenced by createChildren().

void NTupleXML::createChildren3D (  XmlElement *  tag, const DataSource &  ntuple )  [private]

Creates the Dom text node children for 2D histograms. Definition at line 127 of file NTupleXML.cxx. References XmlController::m_xml_doc.

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(), createChildren2D(), PlotterBaseXML::createCutChildren(), ViewBaseXML::createElement(), TupleCutXML::createElement(), TransformXML::createElement(), PointRepXML::createElement(), PlotterBaseXML::createElement(), createElement(), NTupleProjectorXML::createElement(), MapMatrixProjectorXML::createElement(), HiNTupleXML::createElement(), FunctionProjectorXML::createElement(), DataRepXML::createElement(), ColorXML::createElement(), BinToColorXML::createElement(), BinsBaseXML::createElement(), BinningProjectorXML::createElement(), BinnerAxisXML::createElement(), PlotterBaseXML::createFontElement(), and PlotterBaseXML::createFontElements().

XmlElement * NTupleXML::createElement (  const DataSource &  ntuple  )

Returns a newly created XmlElement for DataSource. Definition at line 56 of file NTupleXML.cxx. References createChildren(), BaseXML::createElement(), and setAttributes().

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

string NTupleXML::getName (  const XmlElement &  tag  )  const

Returns the name of the NTuple object. Todo: Implement M4 macro to detect missing string::clear(). Gcc 2.95.3 is missing this function, while gcc 3.2.1 has it. Definition at line 136 of file NTupleXML.cxx. References XmlElement::attribute(), and m_name.

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

const DataSource * NTupleXML::getObject (  const XmlElement &  tag  )

Returns the DataSource corresponding to XmlElement. Definition at line 149 of file NTupleXML.cxx. References std::back_inserter(), std::copy(), XmlElement::fillNodeList(), m_col_name, m_data, m_label, and num_util::size().

void NTupleXML::setAttributes (  XmlElement *  tag, const DataSource &  ntuple )  [private]

Sets the attributes. Definition at line 70 of file NTupleXML.cxx. References DataSource::getName(), BaseXML::m_controller, m_name, and BaseXML::setId(). 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 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 NTupleXML::m_col_name [private]

the attribute name for the column index. Definition at line 46 of file NTupleXML.h. Referenced by createChildren2D(), and getObject().

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

std::string NTupleXML::m_data [private]

The tag name of the column data. Definition at line 50 of file NTupleXML.h. Referenced by createChildren2D(), and getObject().

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 NTupleXML::m_label [private]

The attribute name of the column label. Definition at line 54 of file NTupleXML.h. Referenced by createChildren2D(), and getObject().

std::string NTupleXML::m_name [private]

The tag name for the name attribute. Definition at line 42 of file NTupleXML.h. Referenced by getName(), 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(), BinnerAxisXML::createObject(), PlotterBaseXML::createPlotter(), PointRepXML::setAttributes(), and BinnerAxisXML::setAttributes().

---

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

• NTupleXML.h
• NTupleXML.cxx

---