Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
ColorXML Class Reference

A singleton class that is does XML serialization and deserialization of derived classes of Color with XML. More...

#include <ColorXML.h>

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

List of all members.

Public Member Functions

 ColorXML (XmlController *)
 The only public constructor.
XmlElementcreateElement (const Color &color)
 Create a Color XML element.
XmlElementcreateElement ()
 Creates a new element node.
ColorcreateObject (const XmlElement *element)
 Sets the attributes of the object from the element values.
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.
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

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

Private Attributes

std::string m_blue
 Attribute name for blue.
std::string m_green
 Attribute name for green.
std::string m_red
 Attribute name for red.

Detailed Description

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

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

Definition at line 28 of file ColorXML.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

ColorXML ( const ColorXML ) [private]

A private copy constructor in order to avoid copying.

ColorXML ( XmlController controller)

The only public constructor.

Definition at line 26 of file ColorXML.cxx.


Member Function Documentation

XmlElement * createElement ( const Color color)

Create a Color XML element.

Sets the attribute to represent the color of color and returns the newly created element.

Definition at line 34 of file ColorXML.cxx.

References BaseXML::createElement(), Color::getBlue(), Color::getGreen(), Color::getRed(), ColorXML::m_blue, ColorXML::m_green, ColorXML::m_red, and XmlElement::setAttribute().

Referenced by PointRepXML::createElement().

XmlElement * createElement ( ) [inherited]
Color * createObject ( const XmlElement element)

Sets the attributes of the object from the element values.

Definition at line 45 of file ColorXML.cxx.

References XmlElement::attribute(), ColorXML::m_blue, ColorXML::m_green, ColorXML::m_red, and Color::setColor().

Referenced by PointRepXML::createObject().

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

std::string m_blue [private]

Attribute name for blue.

Definition at line 43 of file ColorXML.h.

Referenced by ColorXML::createElement(), and ColorXML::createObject().

XmlController* m_controller [protected, inherited]
std::string m_green [private]

Attribute name for green.

Definition at line 40 of file ColorXML.h.

Referenced by ColorXML::createElement(), and ColorXML::createObject().

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

Attribute name for red.

Definition at line 37 of file ColorXML.h.

Referenced by ColorXML::createElement(), and ColorXML::createObject().

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 documentation for this class was generated from the following files:

Generated for HippoDraw Class Library by doxygen