research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

More documentation of XML_Node

Browse source
This commit is contained in:
Harry Moffat 2008-10-31 16:46:49 +00:00
parent a862e1b54a
commit 33f5767833
2 changed files with 638 additions and 536 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1122
Cantera/src/base/xml.cpp
View file

File diff suppressed because it is too large Load diff

52
Cantera/src/base/xml.h
View file

@ -104,8 +104,23 @@ namespace Cantera {
class XML_Node {
public:
XML_Node(std::string nm = "--", XML_Node* p = 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.
*
* @param nm Name of the node.
* The default name of the node is "--"
*
* @param p pointer to the root for this node in the tree.
* The default is 0 indicating this is the top of the tree.
*/
XML_Node(const std::string nm = "--", XML_Node * const p = 0);
//! Copy constructor
/*!
* @param right Object to be copied
*/
XML_Node(const XML_Node &right);
//! Assignment operator for XML trees
@ -114,11 +129,40 @@ namespace Cantera {
*/
XML_Node& operator=(const XML_Node &right);
//! Destructor for the object
virtual ~XML_Node();
void addComment(std::string comment);
//! Add a child node to the current node containing a comment
/*!
* Child node will have the name, comment.
*
* @param comment Content of the comment
*/
void addComment(const std::string comment);
//! 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, node is changed.
* There is no copy made of the child node.
*
* @param node Reference to a child XML_Node object
*
* @return Returns a reference to the added node
*/
XML_Node& addChild(XML_Node& node);
XML_Node& addChild(std::string name);
//! 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.
*
* @param sname Name of the new child
*
* @return Returns a reference to the added node
*/
XML_Node& addChild(const std::string sname);
XML_Node& addChild(std::string name, std::string value);
XML_Node& addChild(std::string name, double value, std::string fmt="%g");
void removeChild(XML_Node* node);