HiNTupleXML Class Reference

#include <HiNTupleXML.h>

Inheritance diagram for HiNTupleXML:

Inheritance graph
BaseXML
[legend]
Collaboration diagram for HiNTupleXML:

Collaboration graph
XmlControllerBaseXMLViewBaseXMLPlotterBaseXMLFontXMLAxisModelXMLAxisTickXMLPointRepXMLBinToColorXMLColorXMLDataRepXMLMapMatrixProjectorXMLNTupleProjectorXMLBinningProjectorXMLBinsBaseXMLBinnerAxisXMLNTupleXMLFunctionProjectorXMLTransformXMLTupleCutXMLXmlElementXmlNodeXmlDocumentViewFactory
[legend]
List of all members.

Detailed Description

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

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

Definition at line 29 of file HiNTupleXML.h.

Public Member Functions

XmlElementcreateElement ()
 Creates a new element node.
XmlElementcreateElement (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 HiNTuple object.
const XmlElementgetNode (const XmlElement *element) const
 Returns the single child node of element of the type that can be handled by this object.
const DataSourcegetObject (const std::string) const
 Returns the DataSource corresponding to the filename.
const DataSourcegetObject (const XmlElement &tag) const
 Returns the DataSource corresponding to XmlElement.
 HiNTupleXML (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

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

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

Private Attributes

std::string m_name
 The tag name for the name attribute.


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

HiNTupleXML ( const HiNTupleXML  )  [private]

A private copy constructor in order to avoid copying.

HiNTupleXML ( XmlController  ) 

The only public constructor.

Definition at line 46 of file HiNTupleXML.cxx.


Member Function Documentation

XmlElement * createElement (  )  [inherited]

Creates a new element node.

Uses the current document as determined by the XMLController.

Definition at line 43 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(), BinnerAxisXML::createElement(), PlotterBaseXML::createFontElement(), and PlotterBaseXML::createFontElements().

XmlElement * createElement ( const DataSource ntuple  ) 

Returns a newly created XmlElement for DataSource.

Definition at line 52 of file HiNTupleXML.cxx.

References BaseXML::createElement(), DataSource::getName(), BaseXML::m_controller, HiNTupleXML::m_name, and BaseXML::setId().

Referenced by XmlController::addDataSource().

void 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 58 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(), PlotterBaseXML::handleCutPlotter(), XmlController::openNTuples(), and TupleCutXML::setAttributes().

string getName ( const XmlElement tag  )  const

Returns the name of the HiNTuple 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 68 of file HiNTupleXML.cxx.

References XmlElement::attribute(), and HiNTupleXML::m_name.

Referenced by HiNTupleXML::getObject(), and XmlController::openNTuples().

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

const DataSource * getObject ( const std::string   )  const

Returns the DataSource corresponding to the filename.

Definition at line 85 of file HiNTupleXML.cxx.

References NTupleController::createNTuple(), NTupleController::instance(), RootController::instance(), and FitsController::instance().

const DataSource * getObject ( const XmlElement tag  )  const

Returns the DataSource corresponding to XmlElement.

Definition at line 142 of file HiNTupleXML.cxx.

References HiNTupleXML::getName().

Referenced by XmlController::openNTuples(), and XmlController::openUpdatedNTuples().

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

Sets the unique identification of the object.

Definition at line 64 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 & 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

XmlController* m_controller [protected, inherited]

The singleton XML controller object.

Definition at line 60 of file BaseXML.h.

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

std::string m_name [private]

The tag name for the name attribute.

Definition at line 38 of file HiNTupleXML.h.

Referenced by HiNTupleXML::createElement(), and HiNTupleXML::getName().

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 attribute name for the type of object.

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

Definition at line 54 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:
Generated for HippoDraw Class Library by doxygen