libSBML C++ API  5.18.0
XMLNode Class Reference
Inheritance diagram for XMLNode:
[legend]

Detailed Description

A node in libSBML's XML document tree.

LibSBML implements an XML abstraction layer. This layer presents a uniform XML interface to calling programs regardless of which underlying XML parser libSBML has actually been configured to use. The basic data object in the XML abstraction is a node, represented by XMLNode.

An XMLNode can contain any number of children. Each child is another XMLNode, thereby forming a tree. The methods XMLNode::getNumChildren() and XMLNode::getChild() can be used to access the tree structure starting from a given node.

Each XMLNode is subclassed from XMLToken, and thus has the same methods available as XMLToken. These methods include XMLToken::getNamespaces(), XMLToken::getPrefix(), XMLToken::getName(), XMLToken::getURI(), and XMLToken::getAttributes().

Conversion between an XML string and an XMLNode

LibSBML provides the following utility functions for converting an XML string (e.g., <annotation>...</annotation>) to/from an XMLNode object.

The returned XMLNode object by XMLNode::convertStringToXMLNode() is a dummy root (container) XMLNode if the given XML string has two or more top-level elements (e.g., "<p>...</p><p>...</p>"). In the dummy root node, each top-level element in the given XML string is contained as a child XMLNode. XMLToken::isEOF() can be used to identify if the returned XMLNode object is a dummy node or not. Here is an example:

// Checks if the XMLNode object returned by XMLNode::convertStringToXMLNode()
// is a dummy root node:
std::string str = "...";
if ( xn == NULL )
{
// returned value is null (error)
...
}
else if ( xn->isEOF() )
{
// Root node is a dummy node.
for ( int i = 0; i < xn->getNumChildren(); i++ )
{
// access to each child node of the dummy node.
XMLNode& xnChild = xn->getChild(i);
...
}
}
else
{
// Root node is NOT a dummy node.
...
}
Examples:
addingEvidenceCodes_2.cpp, and createExampleSBML.cpp.

Public Member Functions

int addAttr (const std::string &name, const std::string &value, const std::string namespaceURI="", const std::string prefix="")
 Adds an attribute to the XML element represented by this token. More...
 
int addAttr (const XMLTriple &triple, const std::string &value)
 Adds an attribute to the XML element represented by this token. More...
 
int addChild (const XMLNode &node)
 Adds a copy of node as a child of this XMLNode. More...
 
int addNamespace (const std::string &uri, const std::string prefix="")
 Appends an XML namespace declaration to this token. More...
 
int append (const std::string &chars)
 Appends characters to the text content of token. More...
 
int clearAttributes ()
 Removes all attributes of this XMLToken object. More...
 
int clearNamespaces ()
 Removes all XML namespace declarations from this token. More...
 
XMLNodeclone () const
 Creates and returns a deep copy of this XMLNode object. More...
 
bool equals (const XMLNode &other, bool ignoreURI=false, bool ignoreAttributeValues=false) const
 Compare this XMLNode against another XMLNode returning true if both nodes represent the same XML tree, or false otherwise. More...
 
const XMLAttributesgetAttributes () const
 Returns the attributes of the XML element represented by this token. More...
 
int getAttributesLength () const
 Returns the number of attributes on this XMLToken object. More...
 
int getAttrIndex (const std::string &name, const std::string uri="") const
 Returns the index of the attribute with the given name and namespace URI. More...
 
int getAttrIndex (const XMLTriple &triple) const
 Returns the index of the attribute defined by the given XMLTriple object. More...
 
std::string getAttrName (int index) const
 Returns the name of the nth attribute in this token's list of attributes. More...
 
std::string getAttrPrefix (int index) const
 Returns the prefix of the nth attribute in this token's list of attributes. More...
 
std::string getAttrPrefixedName (int index) const
 Returns the prefixed name of the nth attribute in this token's list of attributes. More...
 
std::string getAttrURI (int index) const
 Returns the XML namespace URI of the nth attribute in this token's list of attributes. More...
 
std::string getAttrValue (int index) const
 Returns the value of the nth attribute in this token's list of attributes. More...
 
std::string getAttrValue (const std::string &name, const std::string uri="") const
 Returns the value of the attribute with a given name and XML namespace URI. More...
 
std::string getAttrValue (const XMLTriple &triple) const
 Returns the value of the attribute specified by a given XMLTriple object. More...
 
const std::string & getCharacters () const
 Returns the character text of token. More...
 
XMLNodegetChild (unsigned int n)
 Returns the nth child of this XMLNode. More...
 
const XMLNodegetChild (unsigned int n) const
 Returns the nth child of this XMLNode. More...
 
XMLNodegetChild (const std::string &name)
 Returns the first child of this XMLNode with the corresponding name. More...
 
const XMLNodegetChild (const std::string &name) const
 Returns the first child of this XMLNode with the corresponding name. More...
 
unsigned int getColumn () const
 Returns the column number at which this token occurs in the input. More...
 
int getIndex (const std::string &name) const
 Return the index of the first child of this XMLNode with the given name. More...
 
unsigned int getLine () const
 Returns the line number at which this token occurs in the input. More...
 
const std::string & getName () const
 Returns the (unqualified) name of token. More...
 
int getNamespaceIndex (const std::string &uri) const
 Returns the index of an XML namespace declaration based on its URI. More...
 
int getNamespaceIndexByPrefix (const std::string &prefix) const
 Returns the index of an XML namespace declaration based on its prefix. More...
 
std::string getNamespacePrefix (int index) const
 Returns the prefix of the nth XML namespace declaration. More...
 
std::string getNamespacePrefix (const std::string &uri) const
 Returns the prefix associated with a given XML namespace URI on this token. More...
 
const XMLNamespacesgetNamespaces () const
 Returns the XML namespaces declared for this token. More...
 
int getNamespacesLength () const
 Returns the number of XML namespaces declared on this token. More...
 
std::string getNamespaceURI (int index) const
 Returns the URI of the nth XML namespace declared on this token. More...
 
std::string getNamespaceURI (const std::string prefix="") const
 Returns the URI of an XML namespace with a given prefix. More...
 
unsigned int getNumChildren () const
 Returns the number of children for this XMLNode. More...
 
const std::string & getPrefix () const
 Returns the XML namespace prefix of token. More...
 
const std::string & getURI () const
 Returns the XML namespace URI of token. More...
 
bool hasAttr (int index) const
 Returns true if an attribute with the given index exists. More...
 
bool hasAttr (const std::string &name, const std::string uri="") const
 Returns true if an attribute with a given name and namespace URI exists. More...
 
bool hasAttr (const XMLTriple &triple) const
 Returns true if an attribute defined by a given XMLTriple object exists. More...
 
bool hasChild (const std::string &name) const
 Return a boolean indicating whether this XMLNode has a child with the given name. More...
 
bool hasNamespaceNS (const std::string &uri, const std::string &prefix) const
 Returns true if this token has an XML namespace with a given prefix and URI combination. More...
 
bool hasNamespacePrefix (const std::string &prefix) const
 Returns true if this token has an XML namespace with a given prefix. More...
 
bool hasNamespaceURI (const std::string &uri) const
 Returns true if this token has an XML namespace with a given URI. More...
 
XMLNodeinsertChild (unsigned int n, const XMLNode &node)
 Inserts a copy of the given node as the nth child of this XMLNode. More...
 
bool isAttributesEmpty () const
 Returns true if this token has no attributes. More...
 
bool isElement () const
 Returns true if this token represents an XML element. More...
 
bool isEnd () const
 Returns true if this token represents an XML end element. More...
 
bool isEndFor (const XMLToken &element) const
 Returns true if this token represents an XML end element for a particular start element. More...
 
bool isEOF () const
 Returns true if this token is an end of file marker. More...
 
bool isNamespacesEmpty () const
 Returns true if there are no namespaces declared on this token. More...
 
bool isStart () const
 Returns true if this token represents an XML start element. More...
 
bool isText () const
 Returns true if this token represents an XML text element. More...
 
XMLNodeoperator= (const XMLNode &rhs)
 Assignment operator for XMLNode. More...
 
int removeAttr (int n)
 Removes the nth attribute from the XML element represented by this token. More...
 
int removeAttr (const std::string &name, const std::string uri="")
 Removes an attribute from the XML element represented by this token. More...
 
int removeAttr (const XMLTriple &triple)
 Removes an attribute from the XML element represented by this token. More...
 
XMLNoderemoveChild (unsigned int n)
 Removes the nth child of this XMLNode and returns the removed node. More...
 
int removeChildren ()
 Removes all children from this node. More...
 
int removeNamespace (int index)
 Removes the nth XML namespace declaration. More...
 
int removeNamespace (const std::string &prefix)
 Removes an XML namespace declaration having a given prefix. More...
 
int setAttributes (const XMLAttributes &attributes)
 Sets the attributes on the XML element represented by this token. More...
 
int setCharacters (const std::string &chars)
 Sets the characters for this XMLToken. More...
 
int setEnd ()
 Declares that this token represents an XML element end tag. More...
 
int setEOF ()
 Declares that this token is an end-of-file/input marker. More...
 
int setNamespaces (const XMLNamespaces &namespaces)
 Sets the XML namespaces on this XML element. More...
 
int setTriple (const XMLTriple &triple)
 Sets the name, namespace prefix and namespace URI of this token. More...
 
std::string toString ()
 Prints a string representation of the underlying token stream. More...
 
std::string toXMLString () const
 Returns a string representation of this XMLNode. More...
 
int unsetEnd ()
 Declares that this token no longer represents an XML start/end element. More...
 
 XMLNode ()
 Creates a new empty XMLNode with no children. More...
 
 XMLNode (const XMLToken &token)
 Creates a new XMLNode by copying an XMLToken object. More...
 
 XMLNode (const XMLTriple &triple, const XMLAttributes &attributes, const XMLNamespaces &namespaces, const unsigned int line=0, const unsigned int column=0)
 Creates a new start element XMLNode with the given set of attributes and namespace declarations. More...
 
 XMLNode (const XMLTriple &triple, const XMLAttributes &attributes, const unsigned int line=0, const unsigned int column=0)
 Creates a start element XMLNode with the given set of attributes. More...
 
 XMLNode (const XMLTriple &triple, const unsigned int line=0, const unsigned int column=0)
 Creates an end element XMLNode. More...
 
 XMLNode (const std::string &chars, const unsigned int line=0, const unsigned int column=0)
 Creates a text XMLNode. More...
 
 XMLNode (const XMLNode &orig)
 Copy constructor; creates a copy of this XMLNode. More...
 
virtual ~XMLNode ()
 Destroys this XMLNode. More...
 

Static Public Member Functions

static XMLNodeconvertStringToXMLNode (const std::string &xmlstr, const XMLNamespaces *xmlns=NULL)
 Returns an XMLNode which is derived from a string containing XML content. More...
 
static std::string convertXMLNodeToString (const XMLNode *node)
 Returns a string representation of a given XMLNode. More...
 

Constructor & Destructor Documentation

XMLNode::XMLNode ( )

Creates a new empty XMLNode with no children.

XMLNode::XMLNode ( const XMLToken token)

Creates a new XMLNode by copying an XMLToken object.

Parameters
tokenXMLToken to be copied to XMLNode.
XMLNode::XMLNode ( const XMLTriple triple,
const XMLAttributes attributes,
const XMLNamespaces namespaces,
const unsigned int  line = 0,
const unsigned int  column = 0 
)

Creates a new start element XMLNode with the given set of attributes and namespace declarations.

Parameters
tripleXMLTriple.
attributesXMLAttributes, the attributes to set.
namespacesXMLNamespaces, the namespaces to set.
linean unsigned int, the line number (default = 0).
columnan unsigned int, the column number (default = 0).
XMLNode::XMLNode ( const XMLTriple triple,
const XMLAttributes attributes,
const unsigned int  line = 0,
const unsigned int  column = 0 
)

Creates a start element XMLNode with the given set of attributes.

Parameters
tripleXMLTriple.
attributesXMLAttributes, the attributes to set.
linean unsigned int, the line number (default = 0).
columnan unsigned int, the column number (default = 0).
XMLNode::XMLNode ( const XMLTriple triple,
const unsigned int  line = 0,
const unsigned int  column = 0 
)

Creates an end element XMLNode.

Parameters
tripleXMLTriple.
linean unsigned int, the line number (default = 0).
columnan unsigned int, the column number (default = 0).
XMLNode::XMLNode ( const std::string &  chars,
const unsigned int  line = 0,
const unsigned int  column = 0 
)

Creates a text XMLNode.

Parameters
charsa string, the text to be added to the XMLToken.
linean unsigned int, the line number (default = 0).
columnan unsigned int, the column number (default = 0).
XMLNode::~XMLNode ( )
virtual

Destroys this XMLNode.

XMLNode::XMLNode ( const XMLNode orig)

Copy constructor; creates a copy of this XMLNode.

Parameters
origthe XMLNode instance to copy.

Member Function Documentation

int XMLToken::addAttr ( const std::string &  name,
const std::string &  value,
const std::string  namespaceURI = "",
const std::string  prefix = "" 
)
inherited

Adds an attribute to the XML element represented by this token.

This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.
Parameters
namea string, the so-called "local part" of the attribute name; that is, the attribute name without any namespace qualifier or prefix.
valuea string, the value assigned to the attribute.
namespaceURIa string, the XML namespace URI of the attribute.
prefixa string, the prefix for the XML namespace.

Recall that in XML, the complete form of an attribute on an XML element is the following:

prefix:name="value"

The name part is the name of the attribute, the "value" part is the value assigned to the attribute (and it is always a quoted string), and the prefix part is an optional XML namespace prefix. Internally in libSBML, this data is stored in an XMLAttributes object associated with this XMLToken.

Returns
integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:
Note
If an attribute with the same name and XML namespace URI already exists on this XMLToken object, then the previous value will be replaced with the new value provided to this method.
int XMLToken::addAttr ( const XMLTriple triple,
const std::string &  value 
)
inherited

Adds an attribute to the XML element represented by this token.

This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.
Parameters
triplean XMLTriple object defining the attribute, its value, and optionally its XML namespace (if any is provided).
valuea string, the value assigned to the attribute.
Returns
integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:
Note
If an attribute with the same name and XML namespace URI already exists on this XMLToken object, then the previous value will be replaced with the new value provided to this method.
int XMLNode::addChild ( const XMLNode node)

Adds a copy of node as a child of this XMLNode.

The given node is added at the end of the list of children.

Parameters
nodethe XMLNode to be added as child.
Returns
integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:
Note
The given node is added at the end of the children list.
Examples:
addingEvidenceCodes_2.cpp.
int XMLToken::addNamespace ( const std::string &  uri,
const std::string  prefix = "" 
)
inherited

Appends an XML namespace declaration to this token.

The namespace added will be defined by the given XML namespace URI and an optional prefix. If this XMLToken object already possesses an XML namespace declaration with the given prefix, then the existing XML namespace URI will be overwritten by the new one given by uri.

This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.
Parameters
uria string, the XML namespace URI for the namespace.
prefixa string, the namespace prefix to use.
Returns
integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:
int XMLToken::append ( const std::string &  chars)
inherited

Appends characters to the text content of token.

This method only makes sense for XMLToken objects that contains text. If this method is called on a token that represents an XML start or end tag, it will return the code LIBSBML_OPERATION_FAILED.

Parameters
charsstring, characters to append to the text of this token.
Returns
integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:
See also
isText()
isElement()
int XMLToken::clearAttributes ( )
inherited

Removes all attributes of this XMLToken object.

This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.
Returns
integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:
int XMLToken::clearNamespaces ( )
inherited

Removes all XML namespace declarations from this token.

This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.
Returns
integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:
XMLNode * XMLNode::clone ( ) const

Creates and returns a deep copy of this XMLNode object.

Returns
the (deep) copy of this XMLNode object.
XMLNode * XMLNode::convertStringToXMLNode ( const std::string &  xmlstr,
const XMLNamespaces xmlns = NULL 
)
static

Returns an XMLNode which is derived from a string containing XML content.

The XML namespace must be defined using argument xmlns if the corresponding XML namespace attribute is not part of the string of the first argument.

Parameters
xmlstrstring to be converted to a XML node.
xmlnsXMLNamespaces the namespaces to set (default value is NULL).
Note
The caller owns the returned XMLNode and is reponsible for deleting it. The returned XMLNode object is a dummy root (container) XMLNode if the top-level element in the given XML string is NOT <html>, <body>, <annotation>, or <notes>. In the dummy root node, each top-level element in the given XML string is contained as a child XMLNode. XMLToken::isEOF() can be used to identify if the returned XMLNode object is a dummy node.
Returns
a XMLNode which is converted from string xmlstr. If the conversion failed, this method returns NULL.
std::string XMLNode::convertXMLNodeToString ( const XMLNode node)
static

Returns a string representation of a given XMLNode.

Parameters
nodethe XMLNode to be represented as a string.
Returns
a string-form representation of node.
bool XMLNode::equals ( const XMLNode other,
bool  ignoreURI = false,
bool  ignoreAttributeValues = false 
) const

Compare this XMLNode against another XMLNode returning true if both nodes represent the same XML tree, or false otherwise.

Parameters
otheranother XMLNode to compare against.
ignoreURIwhether to ignore the namespace URI when doing the comparison.
ignoreAttributeValueswhetehr to ignore attribute values when doing the comparison.
Returns
boolean indicating whether this XMLNode represents the same XML tree as another.
Parameters
otheranother XMLNode to compare against
Returns
boolean indicating whether this XMLNode represents the same XML tree as another.
const XMLAttributes & XMLToken::getAttributes ( ) const
inherited

Returns the attributes of the XML element represented by this token.

Returns
the attributes of this XML element, stored in an XMLAttributes object.
int XMLToken::getAttributesLength ( ) const
inherited

Returns the number of attributes on this XMLToken object.

Returns
the number of attributes possessed by this token.
See also
hasAttr()
int XMLToken::getAttrIndex ( const std::string &  name,
const std::string  uri = "" 
) const
inherited

Returns the index of the attribute with the given name and namespace URI.

Parameters
namea string, the name of the attribute.
uria string, the namespace URI of the attribute.
Returns
the index of an attribute with the given local name and namespace URI, or -1 if it is not present on this token.
int XMLToken::getAttrIndex ( const XMLTriple triple) const
inherited

Returns the index of the attribute defined by the given XMLTriple object.

Parameters
triplethe XMLTriple object that defines the attribute whose index is being sought.
Returns
the index of an attribute with the given XMLTriple object, or -1 if no such attribute is present on this token.
std::string XMLToken::getAttrName ( int  index) const
inherited

Returns the name of the nth attribute in this token's list of attributes.

Parameters
indexan integer, the position of the attribute whose name is being sought.
Returns
the name of the attribute located at position n in the list of attributes possessed by this XMLToken object.
Note
If index is out of range, this method will return an empty string. XMLToken::hasAttr() can be used to test for an attribute's existence explicitly, and XMLToken::getAttributesLength() can be used to find out the number of attributes possessed by this token.
See also
hasAttr()
getAttributesLength()
std::string XMLToken::getAttrPrefix ( int  index) const
inherited

Returns the prefix of the nth attribute in this token's list of attributes.

Parameters
indexan integer, the position of the attribute whose prefix is being sought.
Returns
the XML namespace prefix of the attribute located at position n in the list of attributes possessed by this XMLToken object.
Note
If index is out of range, this method will return an empty string. XMLToken::hasAttr() can be used to test for an attribute's existence explicitly, and XMLToken::getAttributesLength() can be used to find out the number of attributes possessed by this token.
See also
hasAttr()
getAttributesLength()
std::string XMLToken::getAttrPrefixedName ( int  index) const
inherited

Returns the prefixed name of the nth attribute in this token's list of attributes.

In this context, prefixed name means the name of the attribute prefixed with the XML namespace prefix assigned to the attribute. This will be a string of the form prefix:name.

Parameters
indexan integer, the position of the attribute whose prefixed name is being sought.
Returns
the prefixed name of the attribute located at position n in the list of attributes possessed by this XMLToken object.
Note
If index is out of range, this method will return an empty string. XMLToken::hasAttr() can be used to test for an attribute's existence explicitly, and XMLToken::getAttributesLength() can be used to find out the number of attributes possessed by this token.
std::string XMLToken::getAttrURI ( int  index) const
inherited

Returns the XML namespace URI of the nth attribute in this token's list of attributes.

Parameters
indexan integer, the position of the attribute whose namespace URI is being sought.
Returns
the XML namespace URI of the attribute located at position n in the list of attributes possessed by this XMLToken object.
Note
If index is out of range, this method will return an empty string. XMLToken::hasAttr() can be used to test for an attribute's existence explicitly, and XMLToken::getAttributesLength() can be used to find out the number of attributes possessed by this token.
std::string XMLToken::getAttrValue ( int  index) const
inherited

Returns the value of the nth attribute in this token's list of attributes.

Parameters
indexan integer, the position of the attribute whose value is required.
Returns
the value of the attribute located at position n in the list of attributes possessed by this XMLToken object.
Note
If index is out of range, this method will return an empty string. XMLToken::hasAttr() can be used to test for an attribute's existence explicitly, and XMLToken::getAttributesLength() can be used to find out the number of attributes possessed by this token.
std::string XMLToken::getAttrValue ( const std::string &  name,
const std::string  uri = "" 
) const
inherited

Returns the value of the attribute with a given name and XML namespace URI.

Parameters
namea string, the name of the attribute whose value is being sought.
uria string, the XML namespace URI of the attribute.
Returns
The value of the attribute, as a string.
Note
If an attribute with the given name and uri does not exist on this token object, this method will return an empty string. XMLToken::hasAttr() can be used to test explicitly for the presence of an attribute with a given name and namespace.
std::string XMLToken::getAttrValue ( const XMLTriple triple) const
inherited

Returns the value of the attribute specified by a given XMLTriple object.

Parameters
triplean XMLTriple describing the attribute whose value is being sought.
Returns
The value of the attribute, as a string.
Note
If an attribute defined by the given triple does not exist on this token object, this method will return an empty string. XMLToken::hasAttr() can be used to test explicitly for the existence of an attribute with the properties of a given triple.
const string & XMLToken::getCharacters ( ) const
inherited

Returns the character text of token.

Returns
the characters of this XML token. If this token is not a text token (i.e., it's an XML element and not character content), then this will return an empty string.
See also
isText()
isElement()
XMLNode & XMLNode::getChild ( unsigned int  n)

Returns the nth child of this XMLNode.

If the index n is greater than the number of child nodes, this method returns an empty node.

Parameters
nan unsigned integer, the index of the node to return.
Returns
the nth child of this XMLNode.
const XMLNode & XMLNode::getChild ( unsigned int  n) const

Returns the nth child of this XMLNode.

If the index n is greater than the number of child nodes, this method returns an empty node.

Parameters
nan unsigned integer, the index of the node to return.
Returns
the nth child of this XMLNode.
XMLNode & XMLNode::getChild ( const std::string &  name)

Returns the first child of this XMLNode with the corresponding name.

If no child with corrsponding name can be found, this method returns an empty node.

Parameters
namethe name of the node to return.
Returns
the first child of this XMLNode with given name.

If no child with corrsponding name can be found, this method returns an empty node.

Parameters
namethe name of the node to return
Returns
the first child of this XMLNode with given name.
const XMLNode & XMLNode::getChild ( const std::string &  name) const

Returns the first child of this XMLNode with the corresponding name.

If no child with corrsponding name can be found, this method returns an empty node.

Parameters
namethe name of the node to return.
Returns
the first child of this XMLNode with given name.

If no child with corrsponding name can be found, this method returns an empty node.

Parameters
namethe name of the node to return
Returns
the first child of this XMLNode with given name.
unsigned int XMLToken::getColumn ( ) const
inherited

Returns the column number at which this token occurs in the input.

Returns
the column at which this XMLToken occurred.
int XMLNode::getIndex ( const std::string &  name) const

Return the index of the first child of this XMLNode with the given name.

Parameters
namea string, the name of the child for which the index is required.
Returns
the index of the first child of this XMLNode with the given name, or -1 if not present.
unsigned int XMLToken::getLine ( ) const
inherited

Returns the line number at which this token occurs in the input.

Returns
the line at which this XMLToken occurred.
const string & XMLToken::getName ( ) const
inherited

Returns the (unqualified) name of token.

Returns
the (unqualified) name of token.
int XMLToken::getNamespaceIndex ( const std::string &  uri) const
inherited

Returns the index of an XML namespace declaration based on its URI.

Parameters
uria string, the XML namespace URI of the sought-after namespace.
Returns
the index of the given declaration, or -1 if no such namespace URI is present on this XMLToken object.
int XMLToken::getNamespaceIndexByPrefix ( const std::string &  prefix) const
inherited

Returns the index of an XML namespace declaration based on its prefix.

Parameters
prefixa string, the prefix of the sought-after XML namespace.
Returns
the index of the given declaration, or -1 if no such namespace URI is present on this XMLToken object.
std::string XMLToken::getNamespacePrefix ( int  index) const
inherited

Returns the prefix of the nth XML namespace declaration.

Parameters
indexan integer, position of the required prefix.
Returns
the prefix of an XML namespace declaration in the XMLNamespaces (by position).
Note
If index is out of range, this method will return an empty string. XMLToken::getNamespacesLength() can be used to find out how many namespaces are defined on this XMLToken object.
See also
getNamespacesLength()
std::string XMLToken::getNamespacePrefix ( const std::string &  uri) const
inherited

Returns the prefix associated with a given XML namespace URI on this token.

Parameters
uria string, the URI of the namespace whose prefix is being sought.
Returns
the prefix of an XML namespace declaration on this XMLToken object.
Note
If there is no XML namespace with the given uri declared on this XMLToken object, this method will return an empty string.
const XMLNamespaces & XMLToken::getNamespaces ( ) const
inherited

Returns the XML namespaces declared for this token.

Returns
the XML namespace declarations for this XML element.
int XMLToken::getNamespacesLength ( ) const
inherited

Returns the number of XML namespaces declared on this token.

Returns
the number of XML namespaces stored in the XMLNamespaces object of this XMLToken object.
std::string XMLToken::getNamespaceURI ( int  index) const
inherited

Returns the URI of the nth XML namespace declared on this token.

Parameters
indexan integer, the position of the sought-after XML namespace URI.
Returns
the URI of the nth XML namespace stored in the XMLNamespaces object in this XMLToken object.
Note
If index is out of range, this method will return an empty string.
See also
getNamespacesLength()
std::string XMLToken::getNamespaceURI ( const std::string  prefix = "") const
inherited

Returns the URI of an XML namespace with a given prefix.

Parameters
prefixa string, the prefix of the sought-after XML namespace URI.
Returns
the URI of an XML namespace declaration given its prefix.
Note
If there is no XML namespace with the given prefix stored in the XMLNamespaces object of this XMLToken object, this method will return an empty string.
unsigned int XMLNode::getNumChildren ( ) const

Returns the number of children for this XMLNode.

Returns
the number of children for this XMLNode.
const string & XMLToken::getPrefix ( ) const
inherited

Returns the XML namespace prefix of token.

Returns
the XML namespace prefix of token.
Note
If no XML namespace prefix has been assigned to this token, this method will return an empty string.
const string & XMLToken::getURI ( ) const
inherited

Returns the XML namespace URI of token.

Returns
the XML namespace URI of token.
bool XMLToken::hasAttr ( int  index) const
inherited

Returns true if an attribute with the given index exists.

Parameters
indexan integer, the position of the attribute.
Returns
true if this token object possesses an attribute with the given index, false otherwise.
bool XMLToken::hasAttr ( const std::string &  name,
const std::string  uri = "" 
) const
inherited

Returns true if an attribute with a given name and namespace URI exists.

Parameters
namea string, the name of the attribute being sought.
uria string, the XML namespace URI of the attribute being sought.
Returns
true if an attribute with the given local name and namespace URI exists in the list of attributes on this token object, false otherwise.
bool XMLToken::hasAttr ( const XMLTriple triple) const
inherited

Returns true if an attribute defined by a given XMLTriple object exists.

Parameters
triplean XMLTriple object describing the attribute being sought.
Returns
true if an attribute matching the properties of the given XMLTriple object exists in the list of attributes on this token, false otherwise.
bool XMLNode::hasChild ( const std::string &  name) const

Return a boolean indicating whether this XMLNode has a child with the given name.

Parameters
namea string, the name of the child to be checked.
Returns
boolean indicating whether this XMLNode has a child with the given name.
bool XMLToken::hasNamespaceNS ( const std::string &  uri,
const std::string &  prefix 
) const
inherited

Returns true if this token has an XML namespace with a given prefix and URI combination.

Parameters
uria string, the URI for the namespace.
prefixa string, the prefix for the namespace.
Returns
true if an XML namespace with the given URI/prefix pair is contained in the XMLNamespaces object of this XMLToken object, false otherwise.
bool XMLToken::hasNamespacePrefix ( const std::string &  prefix) const
inherited

Returns true if this token has an XML namespace with a given prefix.

Parameters
prefixa string, the prefix for the XML namespace.
Returns
true if an XML Namespace with the given URI is contained in the XMLNamespaces of this XMLToken, false otherwise.
bool XMLToken::hasNamespaceURI ( const std::string &  uri) const
inherited

Returns true if this token has an XML namespace with a given URI.

Parameters
uria string, the URI of the XML namespace.
Returns
true if an XML namespace with the given URI is contained in the XMLNamespaces object of this XMLToken object, false otherwise.
XMLNode & XMLNode::insertChild ( unsigned int  n,
const XMLNode node 
)

Inserts a copy of the given node as the nth child of this XMLNode.

If the given index n is out of range for this XMLNode instance, the node is added at the end of the list of children. Even in that situation, this method does not throw an error.

Parameters
nan integer, the index at which the given node is inserted.
nodean XMLNode to be inserted as nth child.
Returns
a reference to the newly-inserted child node.
bool XMLToken::isAttributesEmpty ( ) const
inherited

Returns true if this token has no attributes.

Returns
true if the list of attributes on XMLToken object is empty, false otherwise.
bool XMLToken::isElement ( ) const
inherited

Returns true if this token represents an XML element.

This generic predicate returns true if the element is either a start or end tag, and false if it's a text object. The related methods XMLToken:isStart(), XMLToken::isEnd() and XMLToken::isText() are more specific predicates.

Returns
true if this XMLToken object represents an XML element, false otherwise.
See also
isStart()
isEnd()
isText()
bool XMLToken::isEnd ( ) const
inherited

Returns true if this token represents an XML end element.

Returns
true if this XMLToken object represents an XML end element, false otherwise.
See also
isStart()
isElement()
isText()
bool XMLToken::isEndFor ( const XMLToken element) const
inherited

Returns true if this token represents an XML end element for a particular start element.

Parameters
elementXMLToken, the element with which the current object should be compared to determined whether the current object is a start element for the given one.
Returns
true if this XMLToken object represents an XML end tag for the start tag given by element, false otherwise.
See also
isElement()
isStart()
isEnd()
isText()
bool XMLToken::isEOF ( ) const
inherited

Returns true if this token is an end of file marker.

Returns
true if this XMLToken object represents the end of the input, false otherwise.
See also
setEOF()
bool XMLToken::isNamespacesEmpty ( ) const
inherited

Returns true if there are no namespaces declared on this token.

Returns
true if the XMLNamespaces object stored in this XMLToken token is empty, false otherwise.
bool XMLToken::isStart ( ) const
inherited

Returns true if this token represents an XML start element.

Returns
true if this XMLToken is an XML start element, false otherwise.
See also
isElement()
isEnd()
isText()
bool XMLToken::isText ( ) const
inherited

Returns true if this token represents an XML text element.

Returns
true if this XMLToken is an XML text element, false otherwise.
See also
isElement()
isStart()
isEnd()
XMLNode & XMLNode::operator= ( const XMLNode rhs)

Assignment operator for XMLNode.

Parameters
rhsthe XMLNode object whose values are used as the basis of the assignment.
int XMLToken::removeAttr ( int  n)
inherited

Removes the nth attribute from the XML element represented by this token.

This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.
Parameters
nan integer the index of the resource to be deleted.
Returns
integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are: The value LIBSBML_INDEX_EXCEEDS_SIZE is returned if there is no attribute on this element at the given index n.
See also
getAttrIndex(const XMLTriple& triple) const
getAttrIndex(const std::string& name, const std::string& uri) const
getAttributesLength()
int XMLToken::removeAttr ( const std::string &  name,
const std::string  uri = "" 
)
inherited

Removes an attribute from the XML element represented by this token.

This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.
Parameters
namea string, the name of the attribute to be removed.
uria string, the XML namespace URI of the attribute to be removed.
Returns
integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are: The value LIBSBML_INDEX_EXCEEDS_SIZE is returned if there is no attribute on this element with the given name (and uri if specified).
See also
hasAttr(const std::string name, const std::string uri) const
int XMLToken::removeAttr ( const XMLTriple triple)
inherited

Removes an attribute from the XML element represented by this token.

This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.
Parameters
triplean XMLTriple describing the attribute to be removed.
Returns
integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are: The value LIBSBML_INDEX_EXCEEDS_SIZE is returned if there is no attribute on this element matching the properties of the given triple.
See also
hasAttr(const XMLTriple& triple) const
XMLNode * XMLNode::removeChild ( unsigned int  n)

Removes the nth child of this XMLNode and returns the removed node.

It is important to keep in mind that a given XMLNode may have more than one child. Calling this method erases all existing references to child nodes after the given position n. If the index n is greater than the number of child nodes in this XMLNode, this method takes no action (and returns NULL).

Parameters
nan integer, the index of the node to be removed.
Returns
the removed child, or NULL if n is greater than the number of children in this node.
Note
The caller owns the returned node and is responsible for deleting it.
int XMLNode::removeChildren ( )

Removes all children from this node.

Returns
integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:
int XMLToken::removeNamespace ( int  index)
inherited

Removes the nth XML namespace declaration.

This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.
Parameters
indexan integer, the position of the namespace to be removed. The position in this context refers to the position of the namespace in the XMLNamespaces object stored in this XMLToken object. Callers can use one of the getNamespace___() methods to find the index number of a given namespace.
Returns
integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:
See also
getNamespaceIndex()
getNamespaceIndexByPrefix()
getNamespacesLength()
int XMLToken::removeNamespace ( const std::string &  prefix)
inherited

Removes an XML namespace declaration having a given prefix.

This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.
Parameters
prefixa string, the prefix of the namespace to be removed.
Returns
integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are: The value LIBSBML_INDEX_EXCEEDS_SIZE is returned if there is no namespace with the given prefix on this element.
See also
getNamespaceIndexByPrefix()
int XMLToken::setAttributes ( const XMLAttributes attributes)
inherited

Sets the attributes on the XML element represented by this token.

This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.
Parameters
attributesan XMLAttributes object to be assigned to this XMLToken object, thereby setting the XML attributes associated with this token.
Returns
integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:
Note
This function replaces any existing XMLAttributes object on this XMLToken object with the one given by attributes.
int XMLToken::setCharacters ( const std::string &  chars)
inherited

Sets the characters for this XMLToken.

This method only makes sense for XMLToken objects that contains text. If this method is called on a token that represents an XML start or end tag, it will return the code LIBSBML_OPERATION_FAILED.

Parameters
charsstring, characters to append to the text of this token.
Returns
integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:
See also
isText()
isElement()
int XMLToken::setEnd ( )
inherited

Declares that this token represents an XML element end tag.

Returns
integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:
See also
isStart()
isEnd()
Examples:
addingEvidenceCodes_2.cpp.
int XMLToken::setEOF ( )
inherited

Declares that this token is an end-of-file/input marker.

Returns
integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:
See also
isEOF()
int XMLToken::setNamespaces ( const XMLNamespaces namespaces)
inherited

Sets the XML namespaces on this XML element.

This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.
Parameters
namespacesthe XMLNamespaces object to be assigned to this XMLToken object.
Returns
integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:
Note
This function replaces any existing XMLNamespaces object on this XMLToken object with the new one given by namespaces.
int XMLToken::setTriple ( const XMLTriple triple)
inherited

Sets the name, namespace prefix and namespace URI of this token.

This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.
Parameters
triplethe new XMLTriple to use for this XMLToken object. If this XMLToken already had an XMLTriple object stored within it, that object will be replaced.
Returns
integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:
string XMLToken::toString ( )
inherited

Prints a string representation of the underlying token stream.

This method is intended for debugging purposes.

Returns
a text string representing this XMLToken object.
std::string XMLNode::toXMLString ( ) const

Returns a string representation of this XMLNode.

Returns
a string derived from this XMLNode.
int XMLToken::unsetEnd ( )
inherited

Declares that this token no longer represents an XML start/end element.

Returns
integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are: