XML_Node Class Reference

Class XML_Node is a tree-based representation of the contents of an XML file. More...

#include <xml.h>

Collaboration diagram for XML_Node:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 XML_Node (const char *cnm=0)
 Default constructor for XML_Node, representing a tree structure.
 XML_Node (const std::string nm, XML_Node *const p)
 Default constructor for XML_Node, representing a tree structure.
 XML_Node (const XML_Node &right)
 Copy constructor.
XML_Node & operator= (const XML_Node &right)
 Assignment operator for XML trees.
virtual ~XML_Node ()
 Destructor for the object.
void addComment (const std::string &comment)
 Add a child node to the current node containing a comment.
XML_Node & addChild (XML_Node &node)
 Add a child node to the current node.
XML_Node & addChild (const std::string &sname)
 Add a child node to the current node with a specified name.
XML_Node & addChild (const std::string &name, const std::string &value)
 Add a child node to the current xml node, and at the same time add a value to the child.
XML_Node & addChild (const std::string &name, const doublereal value, const std::string fmt="%g")
 Add a child node to the current xml node, and at the same time add a formatted value to the child.
void removeChild (const XML_Node *const node)
 Remove a child from this node's list of children.
void addValue (const std::string &val)
 Modify the value for the current node.
void addValue (const doublereal val, const std::string fmt="%g")
 Modify the value for the current node.
std::string value () const
 Return the value of an XML node as a string.
std::string operator() () const
 Overloaded parenthesis operator returns the value of the Node.
std::string value (const std::string &cname) const
 Return the value of an XML child node as a string.
std::string operator() (std::string cname) const
 The Overloaded parenthesis operator with one augment returns the value of an XML child node as a string.
doublereal fp_value () const
 Return the value of an XML node as a single double.
integer int_value () const
 Return the value of an XML node as a single int.
void addAttribute (const std::string &attrib, const std::string &value)
 Add or modify an attribute of the current node.
void addAttribute (const std::string &attrib, const doublereal value, const std::string fmt="%g")
 Add or modify an attribute to the double, value.
std::string operator[] (const std::string &attr) const
 The operator[] is overloaded to provide a lookup capability on attributes for the current XML element.
std::string attrib (const std::string &attr) const
 Function returns the value of an attribute.
void clear ()
 Clear the current node and everything under it.
void setLineNumber (const int n)
 Set the line number.
int lineNumber () const
 Return the line number.
XML_Node * parent () const
 Returns a pointer to the parent node of the current node.
XML_Node * setParent (XML_Node *const p)
 Sets the pointer for the parent node of the current node.
bool hasChild (const std::string ch) const
 Tests whether the current node has a child node with a particular name.
bool hasAttrib (std::string a) const
 Tests whether the current node has an attribute with a particular name.
std::string name () const
 Returns the name of the XML node.
void setName (std::string name)
 Sets the name of the XML node.
std::string id () const
 Return the id attribute, if present.
XML_Node & child (const int n) const
 Return a changeable reference to the n'th child of the current node.
const std::vector< XML_Node * > & children () const
 Return an unchangeable reference to the vector of children of the current node.
int nChildren () const
 return the number of children
void _require (const std::string &a, const std::string &v) const
 Require that the current xml node have an attribute named by the first argument, a, and that this attribute have the the string value listed in the second argument, v.
XML_Node * findNameID (const std::string &nameTarget, const std::string &idTarget) const
 This routine carries out a recursive search for an XML node based on both the xml element name and the attribute ID.
XML_Node * findID (const std::string &id, const int depth=100) const
 This routine carries out a recursive search for an XML node based on the xml element attribute ID.
XML_Node * findByAttr (const std::string &attr, const std::string &val) const
 This routine carries out a recursive search for an XML node based on an attribute of each XML node.
const XML_Node * findByName (const std::string &nm) const
 This routine carries out a recursive search for an XML node based on the name of the node.
XML_Node * findByName (const std::string &nm)
 This routine carries out a recursive search for an XML node based on the name of the node.
void getChildren (const std::string &name, std::vector< XML_Node * > &children) const
 Get a vector of pointers to XML_Node containing all of the children of the current node which matches the input name.
XML_Node & child (const std::string &loc) const
 Return a changeable reference to a child of the current node, named by the argument.
void writeHeader (std::ostream &s)
 Write the header to the xml file to the specified ostream.
void write (std::ostream &s, const int level=0) const
 Write an XML subtree to an output stream.
XML_Node & root () const
 Return the root of the current XML_Node tree.
void setRoot (const XML_Node &root)
 Set the root XML_Node value within the current node.
void build (std::istream &f)
 Main routine to create an tree-like representation of an XML file.
void copyUnion (XML_Node *const node_dest) const
 Copy all of the information in the current XML_Node tree into the destination XML_Node tree, doing a union operation as we go.
void copy (XML_Node *const node_dest) const
 Copy all of the information in the current XML_Node tree into the destination XML_Node tree, doing a complete copy as we go.
void lock ()
 Set the lock for this node and all of its children.
void unlock ()
 Unset the lock for this node and all of its children.

Protected Attributes

std::string m_name
 XML node name of the node.
std::string m_value
 Value of the xml node.
std::map< std::string, XML_Node * > m_childindex
 Map containing an index between the node name and the pointer to the node.
std::map< std::string,
std::string > 		m_attribs
 Storage of attributes for a node.
XML_Node * m_parent
 Pointer to the parent XML_Node for the current node.
XML_Node * m_root
 Pointer to the root XML_Node for the current node.
bool m_locked
 Lock for this node.
std::vector< XML_Node * > m_children
 Vector of pointers to child nodes.
int m_nchildren
 Number of children of this node.
bool m_iscomment
 True if the current node is a comment node.
int m_linenum
 the member data m_linenum

Private Member Functions

std::map< std::string,
std::string > & 		attribs ()
 Returns a changeable value of the attributes map for the current node.
void write_int (std::ostream &s, int level=0) const
 Write an XML subtree to an output stream.

Detailed Description

Class XML_Node is a tree-based representation of the contents of an XML file.

Class XML_Node is a tree-based representation of the contents of an XML file.

There are routines for adding to the tree.

There are routines for querying and searching the tree.

Additionally, there are routines for writing the tree out to an output file.

Definition at line 156 of file xml.h.

Constructor & Destructor Documentation

XML_Node ( const char *  cnm = 0  ) 

Default constructor for XML_Node, representing a tree structure.

Constructor for an XML_Node, which is a node in a tree-like structure representing an XML file.

Parameters:
cnm Name of the node. The default name of the node is "--"

Definition at line 394 of file xml.cpp.

References XML_Node::m_name, and XML_Node::m_root.

Referenced by XML_Node::addChild().

XML_Node ( const std::string  nm,
XML_Node *const   p 
)

Default constructor for XML_Node, representing a tree structure.

Constructor for an XML_Node, which is a node in a tree-like structure representing an XML file.

Parameters:
nm Name of the node. The default name of the node is "--"
p pointer to the root for this node in the tree. The default is 0 indicating this is the top of the tree.

Definition at line 420 of file xml.cpp.

References XML_Node::m_root, and XML_Node::root().

XML_Node ( const XML_Node &  right  ) 

Copy constructor.

Parameters:
right Object to be copied

Definition at line 436 of file xml.cpp.

References XML_Node::copy(), and XML_Node::m_root.

~XML_Node (  )  [virtual]

Destructor for the object.

Definition at line 471 of file xml.cpp.

References XML_Node::m_children, XML_Node::m_locked, XML_Node::name(), and XML_Node::parent().

Member Function Documentation

void _require ( const std::string &  a,
const std::string &  v 
) const

Require that the current xml node have an attribute named by the first argument, a, and that this attribute have the the string value listed in the second argument, v.

Parameters:
a attribute name
v required value of the attribute

If the condition is not true, an exception is thrown

Definition at line 852 of file xml.cpp.

References XML_Node::attrib(), XML_Node::hasAttrib(), and XML_Node::name().

Referenced by WaterSSTP::setParametersFromXML(), EdgePhase::setParametersFromXML(), and SurfPhase::setParametersFromXML().

void addAttribute ( const std::string &  attrib,
const doublereal  value,
const std::string  fmt = "%g" 
)

Add or modify an attribute to the double, value.

This functions fills in the attribute field, named attrib, with the double value, value. A formatting string is used.

Parameters:
attrib String name for the attribute to be assigned
value double Value that the node will be assigned
fmt Format of the printf string conversion of the double. Default is "%g".

Definition at line 712 of file xml.cpp.

References Cantera::fp2str(), and XML_Node::m_attribs.

void addAttribute ( const std::string &  attrib,
const std::string &  value 
)

Add or modify an attribute of the current node.

This functions fills in the m_value field of the current node with a string value

Parameters:
attrib String name for the attribute to be assigned
value String value that the attribute will have

Definition at line 698 of file xml.cpp.

References XML_Node::m_attribs.

Referenced by XML_Node::copy(), XML_Node::copyUnion(), and MetalSHEelectrons::makeDefaultXMLTree().

XML_Node & addChild ( const std::string &  name,
const doublereal  value,
const std::string  fmt = "%g" 
)

Add a child node to the current xml node, and at the same time add a formatted value to the child.

This version supplies a formatting string (printf format) to the output of the value.

Resulting XML string: <name> value </name>

Parameters:
name Name of the child XML_Node object
value Value of the XML_Node - double.
fmt Format of the output for value
Returns:
Returns a reference to the created child XML_Node object

Definition at line 586 of file xml.cpp.

References XML_Node::addChild(), and XML_Node::addValue().

XML_Node & addChild ( const std::string &  name,
const std::string &  value 
)

Add a child node to the current xml node, and at the same time add a value to the child.

Resulting XML string: <name> value </name>

Parameters:
name Name of the child XML_Node object
value Value of the XML_Node - string
Returns:
Returns a reference to the created child XML_Node object

Definition at line 565 of file xml.cpp.

References XML_Node::addChild(), and XML_Node::addValue().

XML_Node & addChild ( const std::string &  sname  ) 

Add a child node to the current node with a specified name.

This will add an XML_Node as a child to the current node. The node will be blank except for the specified name.

Parameters:
sname Name of the new child
Returns:
Returns a reference to the added node

Definition at line 545 of file xml.cpp.

References XML_Node::m_childindex, XML_Node::m_children, XML_Node::m_nchildren, XML_Node::root(), XML_Node::setParent(), XML_Node::setRoot(), and XML_Node::XML_Node().

XML_Node & addChild ( XML_Node &  node  ) 

Add a child node to the current node.

This will add an XML_Node as a child to the current node. Note, this actually adds the node. Therefore, the current node is changed. There is no copy made of the child node.

Parameters:
node Reference to a child XML_Node object
Returns:
Returns a reference to the added child node

Definition at line 527 of file xml.cpp.

References XML_Node::m_childindex, XML_Node::m_children, XML_Node::m_nchildren, XML_Node::name(), XML_Node::root(), XML_Node::setParent(), and XML_Node::setRoot().

Referenced by XML_Node::addChild(), XML_Node::addComment(), Messages::addLogEntry(), Messages::beginLogGroup(), XML_Node::build(), XML_Node::copy(), XML_Node::copyUnion(), and MetalSHEelectrons::makeDefaultXMLTree().

void addComment ( const std::string &  comment  ) 

Add a child node to the current node containing a comment.

Child node will have the name, comment.

Parameters:
comment Content of the comment

Definition at line 513 of file xml.cpp.

References XML_Node::addChild().

Referenced by XML_Node::build().

void addValue ( const doublereal  val,
const std::string  fmt = "%g" 
)

Modify the value for the current node.

This functions fills in the m_value field of the current node with a formatted double value

Parameters:
val double Value that the node will be assigned
fmt Format of the printf string conversion of the double. Default is "%g". Must be less than 63 chars

Definition at line 633 of file xml.cpp.

References Cantera::fp2str(), XML_Node::m_value, and Cantera::stripws().

void addValue ( const std::string &  val  ) 

Modify the value for the current node.

This functions fills in the m_value field of the current node

Parameters:
val string Value that the node will be assigned

Definition at line 619 of file xml.cpp.

References XML_Node::m_iscomment, XML_Node::m_name, and XML_Node::m_value.

Referenced by XML_Node::addChild(), XML_Node::build(), XML_Node::copy(), and XML_Node::copyUnion().

std::string attrib ( const std::string &  attr  )  const

Function returns the value of an attribute.

This function searches the attibutes vector for the parameter std::string attribute. If a match is found, the attribute value is returned as a string. If no match is found, the empty string is returned.

Parameters:
attr Std::String containing the attribute to be searched for.
Returns:
Returns If a match is found, the attribute value is returned as a string. If no match is found, the empty string is returned.

Definition at line 749 of file xml.cpp.

References XML_Node::m_attribs.

Referenced by XML_Node::_require(), IdealSolidSolnPhase::constructPhaseXML(), HMWSoln::constructPhaseXML(), DebyeHuckel::constructPhaseXML(), XML_Node::copyUnion(), XML_Node::findByAttr(), XML_Node::findID(), XML_Node::id(), MineralEQ3::initThermoXML(), IdealSolnGasVPSS::initThermoXML(), IdealSolidSolnPhase::initThermoXML(), IdealMolalSoln::initThermoXML(), HMWSoln::initThermoXML(), DebyeHuckel::initThermoXML(), XML_Node::operator[](), HMWSoln::readXMLBinarySalt(), HMWSoln::readXMLLambdaNeutral(), HMWSoln::readXMLMunnnNeutral(), HMWSoln::readXMLPsiCommonAnion(), HMWSoln::readXMLPsiCommonCation(), HMWSoln::readXMLThetaAnion(), HMWSoln::readXMLThetaCation(), and HMWSoln::readXMLZetaCation().

std::map< std::string, std::string > & attribs (  )  [private]

Returns a changeable value of the attributes map for the current node.

Note this is a simple accessor routine. And, it is a private function. It's used in some internal copy and assignment routines

Definition at line 760 of file xml.cpp.

References XML_Node::m_attribs.

Referenced by XML_Node::build().

void build ( std::istream &  f  ) 

Main routine to create an tree-like representation of an XML file.

Given an input stream, this routine will read matched XML tags representing the ctml file until an EOF is read from the file. This routine is called by the root XML_Node object.

Parameters:
f Input stream containing the ascii input file

Definition at line 1042 of file xml.cpp.

References XML_Node::addChild(), XML_Node::addComment(), XML_Node::addValue(), XML_Node::attribs(), XML_Reader::m_line, XML_Node::m_name, XML_Node::m_root, XML_Node::name(), XML_Node::parent(), XML_Reader::readTag(), XML_Reader::readValue(), and XML_Node::setLineNumber().

Referenced by PDSS_Water::constructPDSSFile(), PDSS_SSVol::constructPDSSFile(), PDSS_IdealGas::constructPDSSFile(), PDSS_HKFT::constructPDSSFile(), PDSS_ConstVol::constructPDSSFile(), WaterSSTP::constructPhaseFile(), IdealSolidSolnPhase::constructPhaseFile(), IdealMolalSoln::constructPhaseFile(), HMWSoln::constructPhaseFile(), DebyeHuckel::constructPhaseFile(), and ThermoPhase::initThermoFile().

XML_Node & child ( const std::string &  loc  )  const

Return a changeable reference to a child of the current node, named by the argument.

Parameters:
loc Name of the child to return

Definition at line 1210 of file xml.cpp.

References XML_Node::lineNumber(), XML_Node::m_childindex, and XML_Node::m_name.

XML_Node & child ( const int  n  )  const

Return a changeable reference to the n'th child of the current node.

Parameters:
n Number of the child to return

Definition at line 820 of file xml.cpp.

References XML_Node::m_children.

Referenced by Elements::addElementsFromXML(), Elements::addUniqueElement(), PDSS_SSVol::constructPDSSFile(), PDSS_HKFT::constructPDSSFile(), PDSS_ConstVol::constructPDSSFile(), IdealSolidSolnPhase::constructPhaseXML(), HMWSoln::constructPhaseXML(), DebyeHuckel::constructPhaseXML(), electrodeElectron::electrodeElectron(), XML_Node::getChildren(), VPSSMgr_Water_HKFT::initThermoXML(), VPSSMgr_Water_ConstVol::initThermoXML(), VPSSMgr_ConstVol::initThermoXML(), ThermoPhase::initThermoXML(), StoichSubstanceSSTP::initThermoXML(), MineralEQ3::initThermoXML(), MetalSHEelectrons::initThermoXML(), IdealSolnGasVPSS::initThermoXML(), IdealSolidSolnPhase::initThermoXML(), IdealMolalSoln::initThermoXML(), HMWSoln::initThermoXML(), DebyeHuckel::initThermoXML(), SpeciesThermoFactory::installThermoForSpecies(), MetalSHEelectrons::MetalSHEelectrons(), MineralEQ3::MineralEQ3(), VPSSMgrFactory::newVPSSMgr(), HMWSoln::readXMLBinarySalt(), HMWSoln::readXMLCroppingCoefficients(), HMWSoln::readXMLLambdaNeutral(), HMWSoln::readXMLMunnnNeutral(), HMWSoln::readXMLPsiCommonAnion(), HMWSoln::readXMLPsiCommonCation(), HMWSoln::readXMLThetaAnion(), HMWSoln::readXMLThetaCation(), HMWSoln::readXMLZetaCation(), StoichSubstanceSSTP::StoichSubstanceSSTP(), SurfPhase::SurfPhase(), and XML_Node::value().

const std::vector< XML_Node * > & children (  )  const

Return an unchangeable reference to the vector of children of the current node.

Each of the individual XML_Node child pointers, however, is to a changeable xml node object.

Definition at line 831 of file xml.cpp.

References XML_Node::m_children.

Referenced by XML_Node::copy(), XML_Node::copyUnion(), and SpeciesThermoFactory::installThermoForSpecies().

void clear (  ) 

Clear the current node and everything under it.

The value, attributes and children are all zeroed. The name and the parent information is kept.

Definition at line 486 of file xml.cpp.

References XML_Node::m_attribs, XML_Node::m_childindex, XML_Node::m_children, XML_Node::m_iscomment, XML_Node::m_linenum, XML_Node::m_nchildren, XML_Node::m_value, and XML_Node::parent().

void copy ( XML_Node *const   node_dest  )  const

Copy all of the information in the current XML_Node tree into the destination XML_Node tree, doing a complete copy as we go.

Note this is a const function because the current XML_Node and its children isn't altered by this operation.

Parameters:
node_dest This is the XML node to receive the information

Definition at line 1150 of file xml.cpp.

References XML_Node::addAttribute(), XML_Node::addChild(), XML_Node::addValue(), XML_Node::children(), XML_Node::copy(), XML_Node::m_attribs, XML_Node::m_children, XML_Node::m_name, XML_Node::m_nchildren, XML_Node::m_value, XML_Node::name(), XML_Node::nChildren(), and XML_Node::setName().

Referenced by WaterSSTP::constructPhaseFile(), IdealSolidSolnPhase::constructPhaseFile(), IdealMolalSoln::constructPhaseFile(), HMWSoln::constructPhaseFile(), DebyeHuckel::constructPhaseFile(), XML_Node::copy(), ThermoPhase::initThermoFile(), XML_Node::operator=(), and XML_Node::XML_Node().

void copyUnion ( XML_Node *const   node_dest  )  const

Copy all of the information in the current XML_Node tree into the destination XML_Node tree, doing a union operation as we go.

Note this is a const function becuase the current XML_Node and its children isn't altered by this operation. copyUnion() doesn't duplicate existing entries in the destination XML_Node tree.

Parameters:
node_dest This is the XML node to receive the information

Definition at line 1097 of file xml.cpp.

References XML_Node::addAttribute(), XML_Node::addChild(), XML_Node::addValue(), XML_Node::attrib(), XML_Node::children(), XML_Node::copyUnion(), XML_Node::hasAttrib(), XML_Node::m_attribs, XML_Node::m_children, XML_Node::m_iscomment, XML_Node::m_name, XML_Node::m_nchildren, XML_Node::m_value, XML_Node::name(), and XML_Node::nChildren().

Referenced by XML_Node::copyUnion().

XML_Node * findByAttr ( const std::string &  attr,
const std::string &  val 
) const

This routine carries out a recursive search for an XML node based on an attribute of each XML node.

If exact match is found with respect to the attribute name and value of the attribute, the pointer to the matching XML Node is returned. If not, 0 is returned.

Parameters:
attr Attribute of the XML Node that the routine looks for
val Value of the attribute
Returns:
Returns the pointer to the XML node that fits the criteria

Definition at line 962 of file xml.cpp.

References XML_Node::attrib(), XML_Node::hasAttrib(), XML_Node::m_children, and XML_Node::nChildren().

Referenced by Elements::addElementsFromXML(), PDSS_SSVol::constructPDSSFile(), PDSS_HKFT::constructPDSSFile(), PDSS_ConstVol::constructPDSSFile(), VPSSMgr_Water_HKFT::initThermoXML(), VPSSMgr_Water_ConstVol::initThermoXML(), VPSSMgr_ConstVol::initThermoXML(), IdealSolidSolnPhase::initThermoXML(), IdealMolalSoln::initThermoXML(), HMWSoln::initThermoXML(), and DebyeHuckel::initThermoXML().

XML_Node * findByName ( const std::string &  nm  ) 

This routine carries out a recursive search for an XML node based on the name of the node.

If exact match is found with respect to XML_Node name, the pointer to the matching XML Node is returned. If not, 0 is returned. This is the non-const version of the routine.

Parameters:
nm Name of the XML node
Returns:
Returns the pointer to the XML node that fits the criteria

Definition at line 989 of file xml.cpp.

References XML_Node::m_children, XML_Node::name(), and XML_Node::nChildren().

const XML_Node * findByName ( const std::string &  nm  )  const

This routine carries out a recursive search for an XML node based on the name of the node.

If exact match is found with respect to XML_Node name, the pointer to the matching XML Node is returned. If not, 0 is returned. This is the const version of the routine.

Parameters:
nm Name of the XML node
Returns:
Returns the pointer to the XML node that fits the criteria

Definition at line 1013 of file xml.cpp.

References XML_Node::m_children, XML_Node::name(), and XML_Node::nChildren().

Referenced by PDSS_SSVol::constructPDSSXML(), PDSS_HKFT::constructPDSSXML(), PDSS_ConstVol::constructPDSSXML(), VPSSMgr_Water_HKFT::createInstallPDSS(), VPSSMgr_Water_ConstVol::createInstallPDSS(), VPSSMgr_IdealGas::createInstallPDSS(), VPSSMgr_ConstVol::createInstallPDSS(), VPSSMgr_Water_HKFT::initThermoXML(), VPSSMgr_Water_ConstVol::initThermoXML(), VPSSMgr_ConstVol::initThermoXML(), IdealSolidSolnPhase::initThermoXML(), IdealMolalSoln::initThermoXML(), HMWSoln::initThermoXML(), DebyeHuckel::initThermoXML(), and VPSSMgr_General::returnPDSS_ptr().

XML_Node * findID ( const std::string &  id,
const int  depth = 100 
) const

This routine carries out a recursive search for an XML node based on the xml element attribute ID.

If exact match is found, the pointer to the matching XML Node is returned. If not, 0 is returned.

The ID attribute may be defaulted by setting it to "". In this case the pointer to the first xml element matching the name only is returned.

Parameters:
id "id" attribute of the XML Node that the routine looks for
depth Depth of the search.
Returns:
Returns the pointer to the XML node that fits the criteria

For internal use only.

This algorithm does a lateral search of first generation children first before diving deeper into each tree branch.

Definition at line 930 of file xml.cpp.

References XML_Node::attrib(), XML_Node::hasAttrib(), XML_Node::m_children, and XML_Node::nChildren().

Referenced by Cantera::get_XML_Node().

XML_Node * findNameID ( const std::string &  nameTarget,
const std::string &  idTarget 
) const

This routine carries out a recursive search for an XML node based on both the xml element name and the attribute ID.

If exact matches are found for both fields, the pointer to the matching XML Node is returned.

The ID attribute may be defaulted by setting it to "". In this case the pointer to the first xml element matching the name only is returned.

Parameters:
nameTarget Name of the XML Node that is being searched for
idTarget "id" attribute of the XML Node that the routine looks for
Returns:
Returns the pointer to the XML node that fits the criteria

For internal use only.

This algorithm does a lateral search of first generation children first before diving deeper into each tree branch.

Definition at line 883 of file xml.cpp.

References XML_Node::findNameID(), XML_Node::id(), XML_Node::m_children, XML_Node::m_nchildren, and XML_Node::name().

Referenced by XML_Node::findNameID(), and Cantera::get_XML_NameID().

doublereal fp_value (  )  const

Return the value of an XML node as a single double.

This accesses the value string, and then tries to interpret it as a single double value.

Definition at line 658 of file xml.cpp.

References Cantera::atofCheck(), and XML_Node::m_value.

void getChildren ( const std::string &  name,
std::vector< XML_Node * > &  children 
) const

Get a vector of pointers to XML_Node containing all of the children of the current node which matches the input name.

Parameters:
name Name of the XML_Node children to search on
children output vector of pointers to XML_Node children with the matching name

Definition at line 1195 of file xml.cpp.

References XML_Node::child(), XML_Node::name(), and XML_Node::nChildren().

bool hasAttrib ( std::string  a  )  const

Tests whether the current node has an attribute with a particular name.

Parameters:
a Name of the attribute to test
Returns:
Returns true if the attribute exists, false otherwise.

Definition at line 812 of file xml.cpp.

References XML_Node::m_attribs.

Referenced by XML_Node::_require(), Elements::addElementsFromXML(), Elements::addUniqueElement(), XML_Node::copyUnion(), XML_Node::findByAttr(), XML_Node::findID(), XML_Node::id(), MineralEQ3::initThermoXML(), HMWSoln::initThermoXML(), and DebyeHuckel::initThermoXML().

bool hasChild ( const std::string  ch  )  const

Tests whether the current node has a child node with a particular name.

Parameters:
ch Name of the child node to test
Returns:
Returns true if the child node exists, false otherwise.

Definition at line 802 of file xml.cpp.

References XML_Node::m_childindex.

Referenced by Elements::addElementsFromXML(), Elements::addUniqueElement(), PDSS_HKFT::constructPDSSXML(), IdealSolidSolnPhase::constructPhaseXML(), IdealMolalSoln::constructPhaseXML(), HMWSoln::constructPhaseXML(), DebyeHuckel::constructPhaseXML(), ThermoPhase::initThermoXML(), StoichSubstanceSSTP::initThermoXML(), MineralEQ3::initThermoXML(), MetalSHEelectrons::initThermoXML(), IdealSolnGasVPSS::initThermoXML(), IdealSolidSolnPhase::initThermoXML(), IdealMolalSoln::initThermoXML(), HMWSoln::initThermoXML(), DebyeHuckel::initThermoXML(), SpeciesThermoFactory::installThermoForSpecies(), VPSSMgrFactory::newVPSSMgr(), HMWSoln::readXMLCroppingCoefficients(), MetalSHEelectrons::setParametersFromXML(), ThermoPhase::setStateFromXML(), SurfPhase::setStateFromXML(), and MolalityVPSSTP::setStateFromXML().

std::string id (  )  const

Return the id attribute, if present.

Returns the id attribute if present. If not it return the empty string

Definition at line 608 of file xml.cpp.

References XML_Node::attrib(), and XML_Node::hasAttrib().

Referenced by IdealSolidSolnPhase::constructPhaseXML(), IdealMolalSoln::constructPhaseXML(), HMWSoln::constructPhaseXML(), DebyeHuckel::constructPhaseXML(), XML_Node::findNameID(), and IdealMolalSoln::initThermoXML().

integer int_value (  )  const

Return the value of an XML node as a single int.

This accesses the value string, and then tries to interpret it as a single int value.

Definition at line 667 of file xml.cpp.

References XML_Node::m_value.

int lineNumber (  )  const

Return the line number.

Returns:
returns the member data m_linenum

Definition at line 776 of file xml.cpp.

References XML_Node::m_linenum.

Referenced by XML_Node::child().

void lock (  ) 

Set the lock for this node and all of its children.

Definition at line 1172 of file xml.cpp.

References XML_Node::m_children, XML_Node::m_locked, and XML_Node::m_nchildren.

std::string name (  )  const [inline]

Returns the name of the XML node.

The name is the XML node is the XML node name

Definition at line 444 of file xml.h.

References XML_Node::m_name.

Referenced by XML_Node::_require(), XML_Node::addChild(), XML_Node::build(), PDSS_SSVol::constructPDSSXML(), PDSS_HKFT::constructPDSSXML(), PDSS_ConstVol::constructPDSSXML(), XML_Node::copy(), XML_Node::copyUnion(), VPSSMgr_Water_ConstVol::createInstallPDSS(), VPSSMgr_IdealGas::createInstallPDSS(), VPSSMgr_ConstVol::createInstallPDSS(), XML_Node::findByName(), XML_Node::findNameID(), XML_Node::getChildren(), VPSSMgr_ConstVol::initThermoXML(), HMWSoln::initThermoXML(), SpeciesThermoFactory::installThermoForSpecies(), HMWSoln::readXMLBinarySalt(), HMWSoln::readXMLLambdaNeutral(), HMWSoln::readXMLMunnnNeutral(), HMWSoln::readXMLPsiCommonAnion(), HMWSoln::readXMLPsiCommonCation(), HMWSoln::readXMLThetaAnion(), HMWSoln::readXMLThetaCation(), HMWSoln::readXMLZetaCation(), XML_Node::removeChild(), and XML_Node::~XML_Node().

int nChildren (  )  const

return the number of children

Definition at line 839 of file xml.cpp.

References XML_Node::m_nchildren.

Referenced by XML_Node::copy(), XML_Node::copyUnion(), XML_Node::findByAttr(), XML_Node::findByName(), XML_Node::findID(), XML_Node::getChildren(), HMWSoln::initThermoXML(), HMWSoln::readXMLBinarySalt(), HMWSoln::readXMLLambdaNeutral(), HMWSoln::readXMLMunnnNeutral(), HMWSoln::readXMLPsiCommonAnion(), HMWSoln::readXMLPsiCommonCation(), HMWSoln::readXMLThetaAnion(), HMWSoln::readXMLThetaCation(), and HMWSoln::readXMLZetaCation().

std::string operator() ( std::string  cname  )  const

The Overloaded parenthesis operator with one augment returns the value of an XML child node as a string.

Parameters:
cname Name of the child node to the current node, for which you want the value

Definition at line 686 of file xml.cpp.

References XML_Node::value().

std::string operator() (  )  const

Overloaded parenthesis operator returns the value of the Node.

Returns:
Returns the value of the node as a string.

Definition at line 649 of file xml.cpp.

References XML_Node::m_value.

XML_Node & operator= ( const XML_Node &  right  ) 

Assignment operator for XML trees.

Parameters:
right XML tree to copy

Definition at line 452 of file xml.cpp.

References XML_Node::copy(), XML_Node::m_children, and XML_Node::parent().

std::string operator[] ( const std::string &  attr  )  const

The operator[] is overloaded to provide a lookup capability on attributes for the current XML element.

For example xmlNode["id"] will return the value of the attribute "id" for the current XML element. It will return the blank std::string if there isn't an attribute with that name.

Parameters:
attr attribute string to look up
Returns:
Returns a string representing the value of the attribute within the XML node. If there is no attribute with the given name, it returns the null string.

Definition at line 732 of file xml.cpp.

References XML_Node::attrib().

XML_Node * parent (  )  const

Returns a pointer to the parent node of the current node.

Definition at line 781 of file xml.cpp.

References XML_Node::m_parent.

Referenced by XML_Node::build(), XML_Node::clear(), Messages::endLogGroup(), XML_Node::operator=(), and XML_Node::~XML_Node().

void removeChild ( const XML_Node *const   node  ) 

Remove a child from this node's list of children.

This function removes an XML_Node from the children of this node.

Parameters:
node Pointer to the node to be removed. Note, this node isn't modified in any way.

Definition at line 600 of file xml.cpp.

References XML_Node::m_childindex, XML_Node::m_children, XML_Node::m_nchildren, and XML_Node::name().

XML_Node & root (  )  const

Return the root of the current XML_Node tree.

Returns a reference to the root of the current XML tree

Definition at line 1383 of file xml.cpp.

References XML_Node::m_root.

Referenced by XML_Node::addChild(), Elements::addElementsFromXML(), PDSS_SSVol::constructPDSSFile(), PDSS_HKFT::constructPDSSFile(), PDSS_ConstVol::constructPDSSFile(), VPSSMgr_Water_HKFT::initThermoXML(), VPSSMgr_Water_ConstVol::initThermoXML(), VPSSMgr_ConstVol::initThermoXML(), IdealSolidSolnPhase::initThermoXML(), IdealMolalSoln::initThermoXML(), HMWSoln::initThermoXML(), DebyeHuckel::initThermoXML(), Messages::write_logfile(), and XML_Node::XML_Node().

void setLineNumber ( const int  n  ) 

Set the line number.

Parameters:
n the member data m_linenum is set to n

Definition at line 768 of file xml.cpp.

References XML_Node::m_linenum.

Referenced by XML_Node::build().

void setName ( std::string  name  )  [inline]

Sets the name of the XML node.

Parameters:
name The name of the XML node

Definition at line 450 of file xml.h.

References XML_Node::m_name.

Referenced by XML_Node::copy().

XML_Node * setParent ( XML_Node *const   p  ) 

Sets the pointer for the parent node of the current node.

Parameters:
p Pointer to the parent node
Returns:
Returns the pointer p

Definition at line 791 of file xml.cpp.

References XML_Node::m_parent.

Referenced by XML_Node::addChild().

void setRoot ( const XML_Node &  root  ) 

Set the root XML_Node value within the current node.

Parameters:
root Value of the root XML_Node.

Definition at line 1387 of file xml.cpp.

References XML_Node::m_root.

Referenced by XML_Node::addChild().

void unlock (  ) 

Unset the lock for this node and all of its children.

Definition at line 1180 of file xml.cpp.

References XML_Node::m_children, XML_Node::m_locked, and XML_Node::m_nchildren.

std::string value ( const std::string &  cname  )  const

Return the value of an XML child node as a string.

Parameters:
cname Name of the child node to the current node, for which you want the value

Definition at line 676 of file xml.cpp.

References XML_Node::child(), and XML_Node::value().

std::string value (  )  const

Return the value of an XML node as a string.

This is a simple accessor routine

Definition at line 641 of file xml.cpp.

References XML_Node::m_value.

Referenced by XML_Node::operator()(), HMWSoln::readXMLBinarySalt(), HMWSoln::readXMLPsiCommonAnion(), HMWSoln::readXMLPsiCommonCation(), and XML_Node::value().

void write ( std::ostream &  s,
const int  level = 0 
) const

Write an XML subtree to an output stream.

This is a wrapper around the static routine write_int(). All this does is add an endl on to the output stream. write_int() is fine, but the last endl wasn't being written. It also checks for the special name "--". If found and we are at the root of the xml tree, then the block is skipped and the children are processed. "--" is used to denote the top of the tree.

Parameters:
s ostream to write to
level Indentation level to work from

Definition at line 1371 of file xml.cpp.

References XML_Node::m_children, XML_Node::m_name, XML_Node::m_nchildren, XML_Node::m_root, and XML_Node::write_int().

Referenced by Messages::write_logfile(), and XML_NoChild::XML_NoChild().

void write_int ( std::ostream &  s,
int  level = 0 
) const [private]

Write an XML subtree to an output stream.

This is the main recursive routine. It doesn't put a final endl on. This is fixed up in the public method.

Parameters:
s ostream to write to
level Indentation level to work from

Definition at line 1242 of file xml.cpp.

References XML_Node::m_attribs, XML_Node::m_children, XML_Node::m_iscomment, XML_Node::m_name, XML_Node::m_nchildren, and XML_Node::m_value.

Referenced by XML_Node::write().

void writeHeader ( std::ostream &  s  ) 

Write the header to the xml file to the specified ostream.

Parameters:
s ostream to write the output to

Definition at line 1030 of file xml.cpp.

Member Data Documentation

std::map<std::string, std::string> m_attribs [protected]

Storage of attributes for a node.

m_attribs[attribName] = attribValue

Definition at line 730 of file xml.h.

Referenced by XML_Node::addAttribute(), XML_Node::attrib(), XML_Node::attribs(), XML_Node::clear(), XML_Node::copy(), XML_Node::copyUnion(), XML_Node::hasAttrib(), and XML_Node::write_int().

std::map<std::string, XML_Node*> m_childindex [protected]

Map containing an index between the node name and the pointer to the node.

m_childindex[node.name()] = XML_Node *pointer

This object helps to speed up searches

Definition at line 724 of file xml.h.

Referenced by XML_Node::addChild(), XML_Node::child(), XML_Node::clear(), XML_Node::hasChild(), and XML_Node::removeChild().

std::vector<XML_Node*> m_children [protected]

Vector of pointers to child nodes.

Definition at line 752 of file xml.h.

Referenced by XML_Node::addChild(), XML_Node::child(), XML_Node::children(), XML_Node::clear(), XML_Node::copy(), XML_Node::copyUnion(), XML_Node::findByAttr(), XML_Node::findByName(), XML_Node::findID(), XML_Node::findNameID(), XML_Node::lock(), XML_Node::operator=(), XML_Node::removeChild(), XML_Node::unlock(), XML_Node::write(), XML_Node::write_int(), and XML_Node::~XML_Node().

bool m_iscomment [protected]

True if the current node is a comment node.

Definition at line 758 of file xml.h.

Referenced by XML_Node::addValue(), XML_Node::clear(), XML_Node::copyUnion(), and XML_Node::write_int().

int m_linenum [protected]

the member data m_linenum

Currently, unimplemented functionality

Definition at line 764 of file xml.h.

Referenced by XML_Node::clear(), XML_Node::lineNumber(), and XML_Node::setLineNumber().

bool m_locked [protected]

Lock for this node.

Currently, unimplemented functionality. If locked, it means you can't delete this node.

Definition at line 749 of file xml.h.

Referenced by XML_Node::lock(), XML_Node::unlock(), and XML_Node::~XML_Node().

std::string m_name [protected]

XML node name of the node.

For example, if we were in the XML_Node where 

     *       <phase dim="3" id="gas">
     *       </phase>
     *

Then, this string would be equal to "phase". "dim" and "id" are attributes of the XML_Node.

Definition at line 702 of file xml.h.

Referenced by XML_Node::addValue(), XML_Node::build(), XML_Node::child(), XML_Node::copy(), XML_Node::copyUnion(), XML_Node::name(), XML_Node::setName(), XML_Node::write(), XML_Node::write_int(), and XML_Node::XML_Node().

int m_nchildren [protected]

Number of children of this node.

Definition at line 755 of file xml.h.

Referenced by XML_Node::addChild(), XML_Node::clear(), XML_Node::copy(), XML_Node::copyUnion(), XML_Node::findNameID(), XML_Node::lock(), XML_Node::nChildren(), XML_Node::removeChild(), XML_Node::unlock(), XML_Node::write(), and XML_Node::write_int().

XML_Node* m_parent [protected]

Pointer to the parent XML_Node for the current node.

Note, the top node has a parent value of 0

Definition at line 736 of file xml.h.

Referenced by XML_Node::parent(), and XML_Node::setParent().

XML_Node* m_root [protected]

Pointer to the root XML_Node for the current node.

Note, the top node has a root value equal to itself

Definition at line 742 of file xml.h.

Referenced by XML_Node::build(), XML_Node::root(), XML_Node::setRoot(), XML_Node::write(), and XML_Node::XML_Node().

std::string m_value [protected]

Value of the xml node.

This is the string contents of the XML node. For example. The xml node named eps:

<eps> valueString </eps>

has a m_value string containing "valueString".

Definition at line 715 of file xml.h.

Referenced by XML_Node::addValue(), XML_Node::clear(), XML_Node::copy(), XML_Node::copyUnion(), XML_Node::fp_value(), XML_Node::int_value(), XML_Node::operator()(), XML_Node::value(), and XML_Node::write_int().

The documentation for this class was generated from the following files:
Generated by  doxygen 1.6.3