MapMatrixProjectorXML Class Reference

#include <MapMatrixProjectorXML.h>

Inheritance diagram for MapMatrixProjectorXML:

Inheritance graph
BaseXML
[legend]
Collaboration diagram for MapMatrixProjectorXML:

Collaboration graph
DataRepXMLBaseXMLViewBaseXMLPlotterBaseXMLFontXMLAxisModelXMLAxisTickXMLPointRepXMLBinToColorXMLColorXMLNTupleProjectorXMLBinningProjectorXMLBinsBaseXMLBinnerAxisXMLNTupleXMLFunctionProjectorXMLTransformXMLTupleCutXMLHiNTupleXMLXmlControllerXmlElementXmlNodeXmlDocumentViewFactory
[legend]
List of all members.

Detailed Description

An class XML doing serialization and de-serialization of derived classes of MapMatrixProjector.

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

Definition at line 29 of file MapMatrixProjectorXML.h.

Public Member Functions

XmlElementcreateElement ()
 Creates a new element node.
XmlElementcreateElement (const MapMatrixProjector &projector)
 Returns a newly created XML element with attributes set.
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.
 MapMatrixProjectorXML (XmlController *)
 The only public constructor.
void setAttributes (const XmlElement *element, ProjectorBase *projector)
 Sets the MapMatrixProjector attributes of the projector from child nodes of the parent XML element.
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

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

Private Attributes

std::string m_x_bins
 Name of attribute for number X bins.
std::string m_x_orig
 Name of attribute for origin along X direction.
std::string m_x_step
 Name of attribute for number step size in X direction.
std::string m_y_bins
 Name of attribute for number Y bins.
std::string m_y_orig
 Name of attribute for origin along Y direction.
std::string m_y_step
 Name of attribute for number step size in Y direction.


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

MapMatrixProjectorXML ( const MapMatrixProjectorXML  )  [private]

A private copy constructor in order to avoid copying.

MapMatrixProjectorXML ( XmlController  ) 

The only public constructor.

Definition at line 28 of file MapMatrixProjectorXML.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 MapMatrixProjector projector  ) 

Returns a newly created XML element with attributes set.

Definition at line 41 of file MapMatrixProjectorXML.cxx.

References BaseXML::createElement(), MapMatrixProjector::getBinWidth(), MapMatrixProjector::getNumberOfBins(), MapMatrixProjector::getOffset(), BaseXML::m_controller, MapMatrixProjectorXML::m_x_bins, MapMatrixProjectorXML::m_x_orig, MapMatrixProjectorXML::m_x_step, MapMatrixProjectorXML::m_y_bins, MapMatrixProjectorXML::m_y_orig, MapMatrixProjectorXML::m_y_step, XmlElement::setAttribute(), BaseXML::setId(), hippodraw::Axes::X, and hippodraw::Axes::Y.

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

void setAttributes ( const XmlElement element,
ProjectorBase projector 
)

Sets the MapMatrixProjector attributes of the projector from child nodes of the parent XML element.

Definition at line 69 of file MapMatrixProjectorXML.cxx.

References MapMatrixProjectorXML::m_x_bins, MapMatrixProjectorXML::m_x_orig, MapMatrixProjectorXML::m_x_step, MapMatrixProjectorXML::m_y_bins, MapMatrixProjectorXML::m_y_orig, MapMatrixProjectorXML::m_y_step, hippodraw::Axes::X, and hippodraw::Axes::Y.

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

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

std::string m_x_bins [private]

Name of attribute for number X bins.

Definition at line 39 of file MapMatrixProjectorXML.h.

Referenced by MapMatrixProjectorXML::createElement(), and MapMatrixProjectorXML::setAttributes().

std::string m_x_orig [private]

Name of attribute for origin along X direction.

Definition at line 55 of file MapMatrixProjectorXML.h.

Referenced by MapMatrixProjectorXML::createElement(), and MapMatrixProjectorXML::setAttributes().

std::string m_x_step [private]

Name of attribute for number step size in X direction.

Definition at line 47 of file MapMatrixProjectorXML.h.

Referenced by MapMatrixProjectorXML::createElement(), and MapMatrixProjectorXML::setAttributes().

std::string m_y_bins [private]

Name of attribute for number Y bins.

Definition at line 43 of file MapMatrixProjectorXML.h.

Referenced by MapMatrixProjectorXML::createElement(), and MapMatrixProjectorXML::setAttributes().

std::string m_y_orig [private]

Name of attribute for origin along Y direction.

Definition at line 59 of file MapMatrixProjectorXML.h.

Referenced by MapMatrixProjectorXML::createElement(), and MapMatrixProjectorXML::setAttributes().

std::string m_y_step [private]

Name of attribute for number step size in Y direction.

Definition at line 51 of file MapMatrixProjectorXML.h.

Referenced by MapMatrixProjectorXML::createElement(), and MapMatrixProjectorXML::setAttributes().


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