Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Static Private Attributes

AxisTickXML Class Reference

A class that is does XML serialization and de-serialization of AxisTick with XML. More...

#include <AxisTickXML.h>

Inheritance diagram for AxisTickXML:
Inheritance graph
[legend]
Collaboration diagram for AxisTickXML:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 AxisTickXML (XmlController *controller)
 The only public constructor.
XmlElementcreateElement ()
 Creates a new element node.
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.
void setAttributes (XmlElement &tag, const AxisTick &tick)
 Sets the attributes of the XmlElement tag from information in the AxisTick object tick.
void setAttributes (AxisTick *tick, const XmlElement *element)
 Sets the attributes of the AxisTick object tick from the information in the XmlElement 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

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

Private Attributes

std::string m_label
 The attribute name for tick labels.
std::string m_value
 The attribute name for tick values.

Static Private Attributes

static AxisTickXMLs_instance
 The pointer to the singleton object.

Detailed Description

A class that is does XML serialization and de-serialization of AxisTick with XML.

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

Definition at line 28 of file AxisTickXML.h.


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

AxisTickXML ( const AxisTickXML  )  [private]

A private copy constructor in order to avoid copying.

AxisTickXML ( XmlController controller  ) 

The only public constructor.

The parameter controller must object of class derived from XMLController.

Definition at line 23 of file AxisTickXML.cxx.


Member Function Documentation

XmlElement * createElement (  )  [inherited]
void fillNodeList ( const XmlElement element,
std::list< XmlElement * > &  nodelist 
) [inherited]
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 ( AxisTick tick,
const XmlElement element 
)

Sets the attributes of the AxisTick object tick from the information in the XmlElement element.

Definition at line 44 of file AxisTickXML.cxx.

References AxisTickXML::m_label, and AxisTickXML::m_value.

void setAttributes ( XmlElement tag,
const AxisTick tick 
)

Sets the attributes of the XmlElement tag from information in the AxisTick object tick.

Definition at line 32 of file AxisTickXML.cxx.

References AxisTick::content(), AxisTickXML::m_label, AxisTickXML::m_value, XmlElement::setAttribute(), and AxisTick::value().

void setId ( XmlElement tag,
int  id 
) [protected, inherited]
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]
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_label [private]

The attribute name for tick labels.

Definition at line 43 of file AxisTickXML.h.

Referenced by AxisTickXML::setAttributes().

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]
std::string m_value [private]

The attribute name for tick values.

Definition at line 39 of file AxisTickXML.h.

Referenced by AxisTickXML::setAttributes().

AxisTickXML* s_instance [static, private]

The pointer to the singleton object.

Definition at line 35 of file AxisTickXML.h.


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

Generated for HippoDraw Class Library by doxygen