TupleCutXML Class Reference

#include <TupleCutXML.h>

Inheritance diagram for TupleCutXML:

Inheritance graph
BaseXML
[legend]
Collaboration diagram for TupleCutXML:

Collaboration graph
XmlControllerPlotterBaseXMLBaseXMLViewBaseXMLFontXMLAxisModelXMLAxisTickXMLPointRepXMLBinToColorXMLColorXMLDataRepXMLMapMatrixProjectorXMLNTupleProjectorXMLBinningProjectorXMLBinsBaseXMLBinnerAxisXMLNTupleXMLFunctionProjectorXMLTransformXMLHiNTupleXMLXmlElementXmlNodeXmlDocumentViewFactory
[legend]
List of all members.

Detailed Description

A class that is does XML serialization and de-serialization of derived classes of TupleCut.

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

Definition at line 32 of file TupleCutXML.h.

Public Member Functions

XmlElementcreateElement ()
 Creates a new element node.
XmlElementcreateElement (unsigned int i, const TupleCut &cut)
 Returns a newly created XmlElement with attributes set for the TupleCut objects.
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.
TupleCutgetObject (const XmlElement &tag) const
 Creates an TupleCut object and sets its properties from the XmlElement.
void getObjects (const XmlElement *element, std::vector< TupleCut * > &cuts)
 Creates TupleCut objects from old style multidimensional TupleCut.
bool hasMultiDimTupleCut (const XmlElement *element) const
 Returns true if element contains old style NTuple, i.e.
void setAttributes (TupleCut *&cut, const XmlElement *element) const
 Sets the attributes of the TupleCut object plotter from the information in the XmlElement element.
virtual const std::string & tagName () const
 Returns the tag name used by this class.
 TupleCutXML (XmlController *controller)
 The only public constructor.

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

void createChildren (XmlElement &, const TupleCut &)
 Creates the children elements.
void setAxisAttributes (TupleCut *cut, hippodraw::Axes::Type axis, const XmlElement *element) const
 Sets the attributes for each axis of the TupleCut.
 TupleCutXML (const TupleCutXML &)
 A private copy constructor in order to avoid copying.

Private Attributes

std::string m_axis
 The axis attribute name.
std::string m_column
 The column index attribute name.
std::string m_dim
 The number of dimension attribute name.
std::string m_high
 The high end of Range attribute name.
std::string m_invert
 The inversion attribute name.
std::string m_low
 The low end of Range attribute name.

Static Private Attributes

static TupleCutXMLs_instance
 The pointer to the singleton object.


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

TupleCutXML ( const TupleCutXML  )  [private]

A private copy constructor in order to avoid copying.

TupleCutXML ( XmlController controller  ) 

The only public constructor.

The parameter controller must object of class derived from XMLController.

Definition at line 29 of file TupleCutXML.cxx.


Member Function Documentation

void createChildren ( XmlElement ,
const TupleCut  
) [private]

Creates the children elements.

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 ( unsigned int  i,
const TupleCut cut 
)

Returns a newly created XmlElement with attributes set for the TupleCut objects.

Definition at line 42 of file TupleCutXML.cxx.

References BaseXML::createElement(), TupleCut::getColumn(), TupleCut::getInversion(), TupleCut::getRange(), Range::high(), Range::low(), TupleCutXML::m_axis, TupleCutXML::m_column, BaseXML::m_controller, TupleCutXML::m_dim, TupleCutXML::m_high, TupleCutXML::m_invert, TupleCutXML::m_low, XmlController::m_xml_doc, and BaseXML::setId().

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

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

TupleCut * getObject ( const XmlElement tag  )  const

Creates an TupleCut object and sets its properties from the XmlElement.

Definition at line 71 of file TupleCutXML.cxx.

References TupleCutXML::setAttributes().

Referenced by XmlController::getTupleCuts().

void getObjects ( const XmlElement element,
std::vector< TupleCut * > &  cuts 
)

Creates TupleCut objects from old style multidimensional TupleCut.

Definition at line 119 of file TupleCutXML.cxx.

References BaseXML::fillNodeList(), TupleCutXML::m_axis, TupleCutXML::m_dim, TupleCutXML::setAxisAttributes(), hippodraw::Axes::X, and hippodraw::Axes::Y.

bool hasMultiDimTupleCut ( const XmlElement element  )  const

Returns true if element contains old style NTuple, i.e.

one that had a non-negative dimension attribute or none.

Definition at line 107 of file TupleCutXML.cxx.

References TupleCutXML::m_dim.

void setAttributes ( TupleCut *&  cut,
const XmlElement element 
) const

Sets the attributes of the TupleCut object plotter from the information in the XmlElement element.

Definition at line 147 of file TupleCutXML.cxx.

References XmlElement::attribute(), BaseXML::fillNodeList(), TupleCutXML::m_axis, TupleCutXML::m_dim, TupleCutXML::setAxisAttributes(), hippodraw::Axes::X, and hippodraw::Axes::Y.

Referenced by TupleCutXML::getObject().

void setAxisAttributes ( TupleCut cut,
hippodraw::Axes::Type  axis,
const XmlElement element 
) const [private]

Sets the attributes for each axis of the TupleCut.

Bug:
The axis argument is not used.

Definition at line 83 of file TupleCutXML.cxx.

References XmlElement::attribute(), TupleCutXML::m_column, TupleCutXML::m_high, TupleCutXML::m_invert, TupleCutXML::m_low, TupleCut::setColumn(), and TupleCut::setRange().

Referenced by TupleCutXML::getObjects(), and TupleCutXML::setAttributes().

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

std::string m_axis [private]

The axis attribute name.

Definition at line 62 of file TupleCutXML.h.

Referenced by TupleCutXML::createElement(), TupleCutXML::getObjects(), and TupleCutXML::setAttributes().

std::string m_column [private]

The column index attribute name.

Definition at line 50 of file TupleCutXML.h.

Referenced by TupleCutXML::createElement(), and TupleCutXML::setAxisAttributes().

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

std::string m_dim [private]

The number of dimension attribute name.

This attribute is obsolete. But it continues to be used with a negative value to indicate that all TupleCut objects are one dimensional. The lack of this attribute was a bug, and 2D TupleCut objects weren't created from document.

Definition at line 58 of file TupleCutXML.h.

Referenced by TupleCutXML::createElement(), TupleCutXML::getObjects(), TupleCutXML::hasMultiDimTupleCut(), and TupleCutXML::setAttributes().

std::string m_high [private]

The high end of Range attribute name.

Definition at line 44 of file TupleCutXML.h.

Referenced by TupleCutXML::createElement(), and TupleCutXML::setAxisAttributes().

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_invert [private]

The inversion attribute name.

Definition at line 47 of file TupleCutXML.h.

Referenced by TupleCutXML::createElement(), and TupleCutXML::setAxisAttributes().

std::string m_low [private]

The low end of Range attribute name.

Definition at line 41 of file TupleCutXML.h.

Referenced by TupleCutXML::createElement(), and TupleCutXML::setAxisAttributes().

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

TupleCutXML* s_instance [static, private]

The pointer to the singleton object.

Definition at line 38 of file TupleCutXML.h.


The documentation for this class was generated from the following files:
Generated for HippoDraw Class Library by doxygen