HippoDraw Class Library

A class that is does XML serialization and de-serialization of derived classes of AxisModelBase with XML. More...

#include <AxisModelXML.h>

Inheritance diagram for AxisModelXML:

Inheritance graph

Collaboration diagram for AxisModelXML:

Collaboration graph

Public Member Functions
	AxisModelXML (XmlController *controller)
	The only public constructor. More...

XmlElement *	createElement ()
	Creates a new element node. More...

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. More...

hippodraw::Axes::Type	getAxis (const XmlElement *element, const std::string &tagname)
	Returns the Axis attribute value. More...

const XmlElement *	getNode (const XmlElement *element) const
	Returns the single child node of element of the type that can be handled by this object. More...

bool	isLog (const XmlElement *element)
	Returns `true` if the element represents an axis model that is on a logarithmic scale. More...

void	setAttributes (XmlElement &tag, const AxisModelBase &plotter)
	Sets the attributes of the XmlElement tag from information in the AxisModel object plotter. More...

void	setAttributes (AxisModelBase model, const XmlElement element)
	Sets the attributes of the AxisModel object plotter from the information in the XmlElement element. More...

virtual const std::string &	tagName () const
	Returns the tag name used by this class. More...

	~AxisModelXML ()
	The destructor. More...

Protected Types
typedef std::list< XmlElement * >	NodeList_t
	The container type for element nodes. More...

Protected Member Functions
void	setId (XmlElement &tag, int id)
	Sets the unique identification of the object. More...

Protected Attributes
XmlController *	m_controller
	The singleton XML controller object. More...

const std::string	m_id
	The attribute name for the identification of the object. More...

const std::string	m_tagname
	The tag name used for elements created by this class. More...

const std::string	m_type
	The attribute name for the type of object. More...

Private Member Functions
	AxisModelXML (const AxisModelXML &)
	A private copy constructor in order to avoid copying. More...

void	createChildren (XmlElement &, const AxisModelBase &)
	Creates the children elements. More...

void	createChildren (const XmlElement element, AxisModelBase model)
	Creates the children objects. More...

Private Attributes
std::string	m_auto_tick
	The attribute name for axis model that wants auto tick generation. More...

std::string	m_autorange
	The auto ranging attribute name. More...

AxisTickXML *	m_axistick_xml
	The AxisTick XML handler. More...

std::string	m_high
	The high end of Range attribute name. More...

std::string	m_log
	The attribute name for axis model that is logarithmic. More...

std::string	m_low
	The low end of Range attribute name. More...

std::string	m_scale_factor
	the scale factor attribute name. More...

Static Private Attributes
static AxisModelXML *	s_instance
	The pointer to the singleton object. More...

Detailed Description

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

Author: Paul F. Kunz Paul_.nosp@m.Kunz.nosp@m.@slac.nosp@m..sta.nosp@m.nford.nosp@m..edu

Definition at line 31 of file AxisModelXML.h.

Member Typedef Documentation

typedef std::list< XmlElement * > NodeList_t

protectedinherited

The container type for element nodes.

Definition at line 47 of file BaseXML.h.

Constructor & Destructor Documentation

AxisModelXML ( const AxisModelXML & )

private

A private copy constructor in order to avoid copying.

AxisModelXML ( XmlController * controller )

The only public constructor.

The parameter controller must object of class derived from XMLController.

Definition at line 32 of file AxisModelXML.cxx.

References AxisModelXML::m_axistick_xml.

~AxisModelXML ( )

The destructor.

Definition at line 45 of file AxisModelXML.cxx.

References AxisModelXML::m_axistick_xml.

Member Function Documentation

void createChildren	(	XmlElement &	tag,
		const AxisModelBase &	model
	)

private

Creates the children elements.

Definition at line 82 of file AxisModelXML.cxx.

References XmlNode::appendChild(), BaseXML::createElement(), AxisModelBase::getTicks(), i, AxisModelXML::m_axistick_xml, AxisModelXML::setAttributes(), and num_util::size().

Referenced by AxisModelXML::setAttributes().

void createChildren	(	const XmlElement *	element,
		AxisModelBase *	model
	)

private

Creates the children objects.

Definition at line 149 of file AxisModelXML.cxx.

References BaseXML::fillNodeList(), AxisModelXML::m_axistick_xml, and AxisModelXML::setAttributes().

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

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

Axes::Type getAxis	(	const XmlElement *	element,
		const std::string &	tagname
	)

Returns the Axis attribute value.

Definition at line 97 of file AxisModelXML.cxx.

References XmlElement::attribute(), hippodraw::Axes::convert(), and ok.

Referenced by PlotterBaseXML::createAxisModels().

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(), BinningProjectorXML::getObject(), PlotterBaseXML::getObject(), ViewBaseXML::getObjects(), and BinningProjectorXML::setBins().

bool isLog ( const XmlElement * element )

Returns true if the element represents an axis model that is on a logarithmic scale.

Definition at line 107 of file AxisModelXML.cxx.

References XmlElement::attribute(), AxisModelXML::m_log, and ok.

Referenced by PlotterBaseXML::createAxisModels().

void setAttributes	(	XmlElement &	tag,
		const AxisModelBase &	plotter
	)

Sets the attributes of the XmlElement tag from information in the AxisModel object plotter.

Definition at line 50 of file AxisModelXML.cxx.

References AxisModelXML::createChildren(), AxisModelBase::getRange(), AxisModelBase::getScaleFactor(), Range::high(), AxisModelBase::isAutoRanging(), AxisModelBase::isAutoTicks(), AxisModelBase::isLog(), Range::low(), AxisModelXML::m_auto_tick, AxisModelXML::m_autorange, AxisModelXML::m_high, AxisModelXML::m_log, AxisModelXML::m_low, AxisModelXML::m_scale_factor, XmlElement::setAttribute(), and yes.

Referenced by PlotterBaseXML::createAxisModel(), PlotterBaseXML::createAxisModels(), and AxisModelXML::createChildren().

void setAttributes	(	AxisModelBase *	model,
		const XmlElement *	element
	)

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

Definition at line 116 of file AxisModelXML.cxx.

References XmlElement::attribute(), AxisModelXML::createChildren(), AxisModelXML::m_auto_tick, AxisModelXML::m_autorange, AxisModelXML::m_high, AxisModelXML::m_low, AxisModelXML::m_scale_factor, ok, AxisModelBase::setAutoRanging(), AxisModelBase::setRange(), AxisModelBase::setScaleFactor(), and yes.

void setId	(	XmlElement &	tag,
		int	id
	)

protectedinherited

Sets the unique identification of the object.

Definition at line 64 of file BaseXML.cxx.

References BaseXML::m_id, and XmlElement::setAttribute().

Referenced by FunctionProjectorXML::createElement(), HiNTupleXML::createElement(), NTupleProjectorXML::createElement(), BinningProjectorXML::createElement(), ViewBaseXML::createElement(), MapMatrixProjectorXML::createElement(), TupleCutXML::createElement(), DataRepXML::createElement(), PlotterBaseXML::createElement(), NTupleXML::setAttributes(), and PointRepXML::setAttributes().

const string & tagName ( ) const

virtualinherited

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_auto_tick

private

The attribute name for axis model that wants auto tick generation.

Definition at line 61 of file AxisModelXML.h.

Referenced by AxisModelXML::setAttributes().

std::string m_autorange

private

The auto ranging attribute name.

Definition at line 44 of file AxisModelXML.h.

Referenced by AxisModelXML::setAttributes().

AxisTickXML* m_axistick_xml

private

The AxisTick XML handler.

Definition at line 41 of file AxisModelXML.h.

Referenced by AxisModelXML::AxisModelXML(), AxisModelXML::createChildren(), and AxisModelXML::~AxisModelXML().

XmlController* m_controller

protectedinherited

The singleton XML controller object.

Definition at line 60 of file BaseXML.h.

Referenced by ViewBaseXML::connectPlotters(), NTupleProjectorXML::createChildren(), PlotterBaseXML::createCutChildren(), DataRepXML::createDataRep(), FunctionProjectorXML::createElement(), NTupleProjectorXML::createElement(), HiNTupleXML::createElement(), BinningProjectorXML::createElement(), ViewBaseXML::createElement(), MapMatrixProjectorXML::createElement(), TupleCutXML::createElement(), DataRepXML::createElement(), PlotterBaseXML::createElement(), PlotterBaseXML::createFontObjects(), DataRepXML::createFunctionTargetChild(), DataRepXML::createObject(), PlotterBaseXML::createPlotter(), PlotterBaseXML::createTextChildren(), PlotterBaseXML::getCutTargets(), PlotterBaseXML::getObject(), ViewBaseXML::getObjects(), PlotterBaseXML::handleCutPlotter(), PlotterBaseXML::handleFunction(), PlotterBaseXML::handleTextPlotter(), NTupleXML::setAttributes(), and PointRepXML::setAttributes().

std::string m_high

private

The high end of Range attribute name.

Definition at line 50 of file AxisModelXML.h.

Referenced by AxisModelXML::setAttributes().

const std::string m_id

protectedinherited

The attribute name for the identification of the object.

Definition at line 57 of file BaseXML.h.

Referenced by BaseXML::setId().

std::string m_log

private

The attribute name for axis model that is logarithmic.

Definition at line 56 of file AxisModelXML.h.

Referenced by AxisModelXML::isLog(), and AxisModelXML::setAttributes().

std::string m_low

private

The low end of Range attribute name.

Definition at line 47 of file AxisModelXML.h.

Referenced by AxisModelXML::setAttributes().

std::string m_scale_factor

private

the scale factor attribute name.

Definition at line 53 of file AxisModelXML.h.

Referenced by AxisModelXML::setAttributes().

const std::string m_tagname

protectedinherited

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

protectedinherited

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

AxisModelXML* s_instance

staticprivate

The pointer to the singleton object.

Definition at line 37 of file AxisModelXML.h.

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

Generated for HippoDraw Class Library by

doxygen