libSBML C# API  libSBML 5.8.0 C# API
 All Classes Namespaces Files Functions Variables Properties Pages
libsbmlcs.XMLNode Class Reference
Inheritance diagram for libsbmlcs.XMLNode:
[legend]

Detailed Description

Representation of a node in an XML document tree.

Beginning with version 3.0.0, 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:

Public Member Functions

int addAttr (string name, string value, string namespaceURI, string prefix)
 Adds an attribute to the attribute set in this XMLToken optionally with a prefix and URI defining a namespace. More...
 
int addAttr (string name, string value, string namespaceURI)
 Adds an attribute to the attribute set in this XMLToken optionally with a prefix and URI defining a namespace. More...
 
int addAttr (string name, string value)
 Adds an attribute to the attribute set in this XMLToken optionally with a prefix and URI defining a namespace. More...
 
int addAttr (XMLTriple triple, string value)
 Adds an attribute with the given XMLTriple/value pair to the attribute set in this XMLToken. More...
 
int addChild (XMLNode node)
 Adds a copy of node as a child of this XMLNode. More...
 
int addNamespace (string uri, string prefix)
 Appends an XML namespace prefix and URI pair to this XMLToken. More...
 
int addNamespace (string uri)
 Appends an XML namespace prefix and URI pair to this XMLToken. More...
 
int append (string chars)
 Appends characters to this XML text content. More...
 
int clearAttributes ()
 Clears (deletes) all attributes in this XMLToken. More...
 
int clearNamespaces ()
 Clears (deletes) all XML namespace declarations in the XMLNamespaces of this XMLToken. More...
 
new XMLNode clone ()
 Creates and returns a deep copy of this XMLNode. More...
 
override void Dispose ()
 
override bool Equals (Object sb)
 
bool equals (XMLNode other, bool ignoreURI)
 Compare this XMLNode against another XMLNode returning true if both nodes represent the same XML tree, or false otherwise. More...
 
bool equals (XMLNode other)
 Compare this XMLNode against another XMLNode returning true if both nodes represent the same XML tree, or false otherwise. More...
 
XMLAttributes getAttributes ()
 Returns the attributes of this element. More...
 
int getAttributesLength ()
 Return the number of attributes in the attributes set. More...
 
int getAttrIndex (string name, string uri)
 Return the index of an attribute with the given local name and namespace URI. More...
 
int getAttrIndex (string name)
 Return the index of an attribute with the given local name and namespace URI. More...
 
int getAttrIndex (XMLTriple triple)
 Return the index of an attribute with the given XMLTriple. More...
 
string getAttrName (int index)
 Return the local name of an attribute in the attributes set in this XMLToken (by position). More...
 
string getAttrPrefix (int index)
 Return the prefix of an attribute in the attribute set in this XMLToken (by position). More...
 
string getAttrPrefixedName (int index)
 Return the prefixed name of an attribute in the attribute set in this XMLToken (by position). More...
 
string getAttrURI (int index)
 Return the namespace URI of an attribute in the attribute set in this XMLToken (by position). More...
 
string getAttrValue (int index)
 Return the value of an attribute in the attribute set in this XMLToken (by position). More...
 
string getAttrValue (string name, string uri)
 Return a value of an attribute with the given local name and namespace URI. More...
 
string getAttrValue (string name)
 Return a value of an attribute with the given local name and namespace URI. More...
 
string getAttrValue (XMLTriple triple)
 Return a value of an attribute with the given XMLTriple. More...
 
string getCharacters ()
 Returns the text of this element. More...
 
XMLNode getChild (long n)
 Returns the nth child of this XMLNode. More...
 
XMLNode getChild (string name)
 Returns the first child of this XMLNode with the corresponding name. More...
 
long getColumn ()
 Returns the column at which this XMLToken occurred in the input document or data stream. More...
 
override int GetHashCode ()
 
int getIndex (string name)
 Return the index of the first child of this XMLNode with the given name. More...
 
long getLine ()
 Returns the line at which this XMLToken occurred in the input document or data stream. More...
 
string getName ()
 Returns the (unqualified) name of this XML element. More...
 
int getNamespaceIndex (string uri)
 Look up the index of an XML namespace declaration by URI. More...
 
int getNamespaceIndexByPrefix (string prefix)
 Look up the index of an XML namespace declaration by prefix. More...
 
string getNamespacePrefix (int index)
 Look up the prefix of an XML namespace declaration by position. More...
 
string getNamespacePrefix (string uri)
 Look up the prefix of an XML namespace declaration by its URI. More...
 
XMLNamespaces getNamespaces ()
 Returns the XML namespace declarations for this XML element. More...
 
int getNamespacesLength ()
 Returns the number of XML namespaces stored in the XMLNamespaces of this XMLToken. More...
 
string getNamespaceURI (int index)
 Look up the URI of an XML namespace declaration by its position. More...
 
string getNamespaceURI (string prefix)
 Look up the URI of an XML namespace declaration by its prefix. More...
 
string getNamespaceURI ()
 Look up the URI of an XML namespace declaration by its prefix. More...
 
long getNumChildren ()
 Returns the number of children for this XMLNode. More...
 
string getPrefix ()
 Returns the namespace prefix of this XML element. More...
 
string getURI ()
 Returns the namespace URI of this XML element. More...
 
bool hasAttr (int index)
 Predicate returning true or false depending on whether an attribute with the given index exists in the attribute set in this XMLToken. More...
 
bool hasAttr (string name, string uri)
 Predicate returning true or false depending on whether an attribute with the given local name and namespace URI exists in the attribute set in this XMLToken. More...
 
bool hasAttr (string name)
 Predicate returning true or false depending on whether an attribute with the given local name and namespace URI exists in the attribute set in this XMLToken. More...
 
bool hasAttr (XMLTriple triple)
 Predicate returning true or false depending on whether an attribute with the given XML triple exists in the attribute set in this XMLToken. More...
 
bool hasChild (string name)
 Return a bool indicating whether this XMLNode has a child with the given name. More...
 
bool hasNamespaceNS (string uri, string prefix)
 Predicate returning true or false depending on whether an XML Namespace with the given uri/prefix pair is contained in the XMLNamespaces ofthis XMLToken. More...
 
bool hasNamespacePrefix (string prefix)
 Predicate returning true or false depending on whether an XML Namespace with the given prefix is contained in the XMLNamespaces of this XMLToken. More...
 
bool hasNamespaceURI (string uri)
 Predicate returning true or false depending on whether an XML Namespace with the given URI is contained in the XMLNamespaces of this XMLToken. More...
 
XMLNode insertChild (long n, XMLNode node)
 Inserts a copy of the given node as the nth child of this XMLNode. More...
 
bool isAttributesEmpty ()
 Predicate returning true or false depending on whether the attribute set in this XMLToken set is empty. More...
 
bool isElement ()
 Predicate returning true or false depending on whether this XMLToken is an XML element. More...
 
bool isEnd ()
 Predicate returning true or false depending on whether this XMLToken is an XML end element. More...
 
bool isEndFor (XMLToken element)
 Predicate returning true or false depending on whether this XMLToken is an XML end element for the given start element. More...
 
bool isEOF ()
 Predicate returning true or false depending on whether this XMLToken is an end of file marker. More...
 
bool isNamespacesEmpty ()
 Predicate returning true or false depending on whether the XMLNamespaces of this XMLToken is empty. More...
 
bool isStart ()
 Predicate returning true or false depending on whether this XMLToken is an XML start element. More...
 
bool isText ()
 Predicate returning true or false depending on whether this XMLToken is an XML text element. More...
 
int removeAttr (int n)
 Removes an attribute with the given index from the attribute set in this XMLToken. More...
 
int removeAttr (string name, string uri)
 Removes an attribute with the given local name and namespace URI from the attribute set in this XMLToken. More...
 
int removeAttr (string name)
 Removes an attribute with the given local name and namespace URI from the attribute set in this XMLToken. More...
 
int removeAttr (XMLTriple triple)
 Removes an attribute with the given XMLTriple from the attribute set in this XMLToken. More...
 
XMLNode removeChild (long 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 an XML Namespace stored in the given position of the XMLNamespaces of this XMLToken. More...
 
int removeNamespace (string prefix)
 Removes an XML Namespace with the given prefix. More...
 
int setAttributes (XMLAttributes attributes)
 Sets an XMLAttributes to this XMLToken. More...
 
int setEnd ()
 Declares this XML start element is also an end element. More...
 
int setEOF ()
 Declares this XMLToken is an end-of-file (input) marker. More...
 
int setNamespaces (XMLNamespaces namespaces)
 Sets an XMLnamespaces to this XML element. More...
 
int setTriple (XMLTriple triple)
 Sets the XMLTripe (name, uri and prefix) of this XML element. More...
 
string toString ()
 Prints a string representation of the underlying token stream, for debugging purposes. More...
 
string toXMLString ()
 Returns a string representation of this XMLNode. More...
 
int unsetEnd ()
 Declares this XML start/end element is no longer an end element. More...
 
 XMLNode ()
 Creates a new empty XMLNode with no children. More...
 
 XMLNode (XMLToken token)
 Creates a new XMLNode by copying token. More...
 
 XMLNode (XMLTriple triple, XMLAttributes attributes, XMLNamespaces namespaces, long line, long column)
 Creates a new start element XMLNode with the given set of attributes and namespace declarations. More...
 
 XMLNode (XMLTriple triple, XMLAttributes attributes, XMLNamespaces namespaces, long line)
 Creates a new start element XMLNode with the given set of attributes and namespace declarations. More...
 
 XMLNode (XMLTriple triple, XMLAttributes attributes, XMLNamespaces namespaces)
 Creates a new start element XMLNode with the given set of attributes and namespace declarations. More...
 
 XMLNode (XMLTriple triple, XMLAttributes attributes, long line, long column)
 Creates a start element XMLNode with the given set of attributes. More...
 
 XMLNode (XMLTriple triple, XMLAttributes attributes, long line)
 Creates a start element XMLNode with the given set of attributes. More...
 
 XMLNode (XMLTriple triple, XMLAttributes attributes)
 Creates a start element XMLNode with the given set of attributes. More...
 
 XMLNode (XMLTriple triple, long line, long column)
 Creates an end element XMLNode. More...
 
 XMLNode (XMLTriple triple, long line)
 Creates an end element XMLNode. More...
 
 XMLNode (XMLTriple triple)
 Creates an end element XMLNode. More...
 
 XMLNode (string chars, long line, long column)
 Creates a text XMLNode. More...
 
 XMLNode (string chars, long line)
 Creates a text XMLNode. More...
 
 XMLNode (string chars)
 Creates a text XMLNode. More...
 
 XMLNode (XMLInputStream stream)
 Creates a new XMLNode by reading XMLTokens from stream. More...
 
 XMLNode (XMLNode orig)
 Copy constructor; creates a copy of this XMLNode. More...
 

Static Public Member Functions

static XMLNode convertStringToXMLNode (string xmlstr, XMLNamespaces xmlns)
 Returns an XMLNode which is derived from a string containing XML content. More...
 
static XMLNode convertStringToXMLNode (string xmlstr)
 Returns an XMLNode which is derived from a string containing XML content. More...
 
static string convertXMLNodeToString (XMLNode node)
 Returns a string representation of a given XMLNode. More...
 
static bool operator!= (XMLToken lhs, XMLToken rhs)
 
static bool operator!= (XMLNode lhs, XMLNode rhs)
 
static bool operator== (XMLToken lhs, XMLToken rhs)
 
static bool operator== (XMLNode lhs, XMLNode rhs)
 

Protected Attributes

bool swigCMemOwn
 

Constructor & Destructor Documentation

libsbmlcs.XMLNode.XMLNode ( )

Creates a new empty XMLNode with no children.

libsbmlcs.XMLNode.XMLNode ( XMLToken  token)

Creates a new XMLNode by copying token.

Parameters
tokenXMLToken to be copied to XMLNode
libsbmlcs.XMLNode.XMLNode ( XMLTriple  triple,
XMLAttributes  attributes,
XMLNamespaces  namespaces,
long  line,
long  column 
)

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.
linea long integer, the line number (default = 0).
columna long integer, the column number (default = 0).
libsbmlcs.XMLNode.XMLNode ( XMLTriple  triple,
XMLAttributes  attributes,
XMLNamespaces  namespaces,
long  line 
)

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.
linea long integer, the line number (default = 0).
columna long integer, the column number (default = 0).
libsbmlcs.XMLNode.XMLNode ( XMLTriple  triple,
XMLAttributes  attributes,
XMLNamespaces  namespaces 
)

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.
linea long integer, the line number (default = 0).
columna long integer, the column number (default = 0).
libsbmlcs.XMLNode.XMLNode ( XMLTriple  triple,
XMLAttributes  attributes,
long  line,
long  column 
)

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

Parameters
tripleXMLTriple.
attributesXMLAttributes, the attributes to set.
linea long integer, the line number (default = 0).
columna long integer, the column number (default = 0).
libsbmlcs.XMLNode.XMLNode ( XMLTriple  triple,
XMLAttributes  attributes,
long  line 
)

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

Parameters
tripleXMLTriple.
attributesXMLAttributes, the attributes to set.
linea long integer, the line number (default = 0).
columna long integer, the column number (default = 0).
libsbmlcs.XMLNode.XMLNode ( XMLTriple  triple,
XMLAttributes  attributes 
)

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

Parameters
tripleXMLTriple.
attributesXMLAttributes, the attributes to set.
linea long integer, the line number (default = 0).
columna long integer, the column number (default = 0).
libsbmlcs.XMLNode.XMLNode ( XMLTriple  triple,
long  line,
long  column 
)

Creates an end element XMLNode.

Parameters
tripleXMLTriple.
linea long integer, the line number (default = 0).
columna long integer, the column number (default = 0).
libsbmlcs.XMLNode.XMLNode ( XMLTriple  triple,
long  line 
)

Creates an end element XMLNode.

Parameters
tripleXMLTriple.
linea long integer, the line number (default = 0).
columna long integer, the column number (default = 0).
libsbmlcs.XMLNode.XMLNode ( XMLTriple  triple)

Creates an end element XMLNode.

Parameters
tripleXMLTriple.
linea long integer, the line number (default = 0).
columna long integer, the column number (default = 0).
libsbmlcs.XMLNode.XMLNode ( string  chars,
long  line,
long  column 
)

Creates a text XMLNode.

Parameters
charsa string, the text to be added to the XMLToken
linea long integer, the line number (default = 0).
columna long integer, the column number (default = 0).
libsbmlcs.XMLNode.XMLNode ( string  chars,
long  line 
)

Creates a text XMLNode.

Parameters
charsa string, the text to be added to the XMLToken
linea long integer, the line number (default = 0).
columna long integer, the column number (default = 0).
libsbmlcs.XMLNode.XMLNode ( string  chars)

Creates a text XMLNode.

Parameters
charsa string, the text to be added to the XMLToken
linea long integer, the line number (default = 0).
columna long integer, the column number (default = 0).
libsbmlcs.XMLNode.XMLNode ( XMLInputStream  stream)

Creates a new XMLNode by reading XMLTokens from stream.

The stream must be positioned on a start element (stream.peek().isStart() == true) and will be read until the matching end element is found.

Parameters
streamXMLInputStream from which XMLNode is to be created.
libsbmlcs.XMLNode.XMLNode ( XMLNode  orig)

Copy constructor; creates a copy of this XMLNode.

Parameters
origthe XMLNode instance to copy.
Exceptions
XMLConstructorExceptionThrown if the argument orig is null.

Member Function Documentation

int libsbmlcs.XMLToken.addAttr ( string  name,
string  value,
string  namespaceURI,
string  prefix 
)
inherited

Adds an attribute to the attribute set in this XMLToken optionally with a prefix and URI defining a namespace.

Nothing will be done if this XMLToken is not a start element.

Parameters
namea string, the local name of the attribute.
valuea string, the value of the attribute.
namespaceURIa string, the namespace URI of the attribute.
prefixa string, the prefix of the namespace
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
Note
if local name with the same namespace URI already exists in the attribute set, its value and prefix will be replaced.
int libsbmlcs.XMLToken.addAttr ( string  name,
string  value,
string  namespaceURI 
)
inherited

Adds an attribute to the attribute set in this XMLToken optionally with a prefix and URI defining a namespace.

Nothing will be done if this XMLToken is not a start element.

Parameters
namea string, the local name of the attribute.
valuea string, the value of the attribute.
namespaceURIa string, the namespace URI of the attribute.
prefixa string, the prefix of the namespace
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
Note
if local name with the same namespace URI already exists in the attribute set, its value and prefix will be replaced.
int libsbmlcs.XMLToken.addAttr ( string  name,
string  value 
)
inherited

Adds an attribute to the attribute set in this XMLToken optionally with a prefix and URI defining a namespace.

Nothing will be done if this XMLToken is not a start element.

Parameters
namea string, the local name of the attribute.
valuea string, the value of the attribute.
namespaceURIa string, the namespace URI of the attribute.
prefixa string, the prefix of the namespace
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
Note
if local name with the same namespace URI already exists in the attribute set, its value and prefix will be replaced.
int libsbmlcs.XMLToken.addAttr ( XMLTriple  triple,
string  value 
)
inherited

Adds an attribute with the given XMLTriple/value pair to the attribute set in this XMLToken.

Nothing will be done if this XMLToken is not a start element.

Note
if local name with the same namespace URI already exists in the attribute set, its value and prefix will be replaced.
Parameters
triplean XMLTriple, the XML triple of the attribute.
valuea string, the value of the attribute.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.XMLNode.addChild ( 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 possible values returned by this function are:
Note
The given node is added at the end of the children list.
int libsbmlcs.XMLToken.addNamespace ( string  uri,
string  prefix 
)
inherited

Appends an XML namespace prefix and URI pair to this XMLToken.

If there is an XML namespace with the given prefix in this XMLToken, then the existing XML namespace will be overwritten by the new one.

Nothing will be done if this XMLToken is not a start element.

Parameters
uria string, the uri for the namespace
prefixa string, the prefix for the namespace
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.XMLToken.addNamespace ( string  uri)
inherited

Appends an XML namespace prefix and URI pair to this XMLToken.

If there is an XML namespace with the given prefix in this XMLToken, then the existing XML namespace will be overwritten by the new one.

Nothing will be done if this XMLToken is not a start element.

Parameters
uria string, the uri for the namespace
prefixa string, the prefix for the namespace
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.XMLToken.append ( string  chars)
inherited

Appends characters to this XML text content.

Parameters
charsstring, characters to append
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.XMLToken.clearAttributes ( )
inherited

Clears (deletes) all attributes in this XMLToken.

Nothing will be done if this XMLToken is not a start element.

Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.XMLToken.clearNamespaces ( )
inherited

Clears (deletes) all XML namespace declarations in the XMLNamespaces of this XMLToken.

Nothing will be done if this XMLToken is not a start element.

Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
new XMLNode libsbmlcs.XMLNode.clone ( )

Creates and returns a deep copy of this XMLNode.

Returns
a (deep) copy of this XMLNode.
static XMLNode libsbmlcs.XMLNode.convertStringToXMLNode ( string  xmlstr,
XMLNamespaces  xmlns 
)
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.
static XMLNode libsbmlcs.XMLNode.convertStringToXMLNode ( string  xmlstr)
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.
static string libsbmlcs.XMLNode.convertXMLNodeToString ( 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
override void libsbmlcs.XMLNode.Dispose ( )
virtual

Reimplemented from libsbmlcs.XMLToken.

override bool libsbmlcs.XMLNode.Equals ( Object  sb)
bool libsbmlcs.XMLNode.equals ( XMLNode  other,
bool  ignoreURI 
)

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.
Returns
bool indicating whether this XMLNode represents the same XML tree as another.
bool libsbmlcs.XMLNode.equals ( XMLNode  other)

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.
Returns
bool indicating whether this XMLNode represents the same XML tree as another.
XMLAttributes libsbmlcs.XMLToken.getAttributes ( )
inherited

Returns the attributes of this element.

Returns
the XMLAttributes of this XML element.
int libsbmlcs.XMLToken.getAttributesLength ( )
inherited

Return the number of attributes in the attributes set.

Returns
the number of attributes in the attributes set in this XMLToken.
int libsbmlcs.XMLToken.getAttrIndex ( string  name,
string  uri 
)
inherited

Return the index of an attribute with the given local name and namespace URI.

Parameters
namea string, the local 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 not present.
int libsbmlcs.XMLToken.getAttrIndex ( string  name)
inherited

Return the index of an attribute with the given local name and namespace URI.

Parameters
namea string, the local 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 not present.
int libsbmlcs.XMLToken.getAttrIndex ( XMLTriple  triple)
inherited

Return the index of an attribute with the given XMLTriple.

Parameters
triplean XMLTriple, the XML triple of the attribute for which the index is required.
Returns
the index of an attribute with the given XMLTriple, or -1 if not present.
string libsbmlcs.XMLToken.getAttrName ( int  index)
inherited

Return the local name of an attribute in the attributes set in this XMLToken (by position).

Parameters
indexan integer, the position of the attribute whose local name is required.
Returns
the local name of an attribute in this list (by position).
Note
If index is out of range, an empty string will be returned. Use XMLToken::hasAttr() to test for the attribute existence.
string libsbmlcs.XMLToken.getAttrPrefix ( int  index)
inherited

Return the prefix of an attribute in the attribute set in this XMLToken (by position).

Parameters
indexan integer, the position of the attribute whose prefix is required.
Returns
the namespace prefix of an attribute in the attribute set (by position).
Note
If index is out of range, an empty string will be returned. Use XMLToken::hasAttr() to test for the attribute existence.
string libsbmlcs.XMLToken.getAttrPrefixedName ( int  index)
inherited

Return the prefixed name of an attribute in the attribute set in this XMLToken (by position).

Parameters
indexan integer, the position of the attribute whose prefixed name is required.
Returns
the prefixed name of an attribute in the attribute set (by position).
Note
If index is out of range, an empty string will be returned. Use XMLToken::hasAttr() to test for attribute existence.
string libsbmlcs.XMLToken.getAttrURI ( int  index)
inherited

Return the namespace URI of an attribute in the attribute set in this XMLToken (by position).

Parameters
indexan integer, the position of the attribute whose namespace URI is required.
Returns
the namespace URI of an attribute in the attribute set (by position).
Note
If index is out of range, an empty string will be returned. Use XMLToken::hasAttr() to test for attribute existence.
string libsbmlcs.XMLToken.getAttrValue ( int  index)
inherited

Return the value of an attribute in the attribute set in this XMLToken (by position).

Parameters
indexan integer, the position of the attribute whose value is required.
Returns
the value of an attribute in the attribute set (by position).
Note
If index is out of range, an empty string will be returned. Use XMLToken::hasAttr() to test for attribute existence.
string libsbmlcs.XMLToken.getAttrValue ( string  name,
string  uri 
)
inherited

Return a value of an attribute with the given local name and namespace URI.

Parameters
namea string, the local name of the attribute whose value is required.
uria string, the namespace URI of the attribute.
Returns
The attribute value as a string.
Note
If an attribute with the given local name and namespace URI does not exist, an empty string will be returned. Use XMLToken::hasAttr() to test for attribute existence.
string libsbmlcs.XMLToken.getAttrValue ( string  name)
inherited

Return a value of an attribute with the given local name and namespace URI.

Parameters
namea string, the local name of the attribute whose value is required.
uria string, the namespace URI of the attribute.
Returns
The attribute value as a string.
Note
If an attribute with the given local name and namespace URI does not exist, an empty string will be returned. Use XMLToken::hasAttr() to test for attribute existence.
string libsbmlcs.XMLToken.getAttrValue ( XMLTriple  triple)
inherited

Return a value of an attribute with the given XMLTriple.

Parameters
triplean XMLTriple, the XML triple of the attribute whose value is required.
Returns
The attribute value as a string.
Note
If an attribute with the given XMLTriple does not exist, an empty string will be returned. Use XMLToken::hasAttr() to test for attribute existence.
string libsbmlcs.XMLToken.getCharacters ( )
inherited

Returns the text of this element.

Returns
the characters of this XML text.
XMLNode libsbmlcs.XMLNode.getChild ( long  n)

Returns the nth child of this XMLNode.

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

Parameters
nthe index of the node to return
Returns
the nth child of this XMLNode.
XMLNode libsbmlcs.XMLNode.getChild ( 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.
long libsbmlcs.XMLToken.getColumn ( )
inherited

Returns the column at which this XMLToken occurred in the input document or data stream.

Returns
the column at which this XMLToken occurred.
override int libsbmlcs.XMLNode.GetHashCode ( )
int libsbmlcs.XMLNode.getIndex ( string  name)

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.
long libsbmlcs.XMLToken.getLine ( )
inherited

Returns the line at which this XMLToken occurred in the input document or data stream.

Returns
the line at which this XMLToken occurred.
string libsbmlcs.XMLToken.getName ( )
inherited

Returns the (unqualified) name of this XML element.

Returns
the (unqualified) name of this XML element.
int libsbmlcs.XMLToken.getNamespaceIndex ( string  uri)
inherited

Look up the index of an XML namespace declaration by URI.

Parameters
uria string, uri of the required namespace.
Returns
the index of the given declaration, or -1 if not present.
int libsbmlcs.XMLToken.getNamespaceIndexByPrefix ( string  prefix)
inherited

Look up the index of an XML namespace declaration by prefix.

Parameters
prefixa string, prefix of the required namespace.
Returns
the index of the given declaration, or -1 if not present.
string libsbmlcs.XMLToken.getNamespacePrefix ( int  index)
inherited

Look up the prefix of an XML namespace declaration by position.

Callers should use getNamespacesLength() to find out how many namespaces are stored in the XMLNamespaces.

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, an empty string will be returned.
See Also
getNamespacesLength()
string libsbmlcs.XMLToken.getNamespacePrefix ( string  uri)
inherited

Look up the prefix of an XML namespace declaration by its URI.

Parameters
uria string, the URI of the prefix being sought
Returns
the prefix of an XML namespace declaration given its URI.
Note
If uri does not exist, an empty string will be returned.
XMLNamespaces libsbmlcs.XMLToken.getNamespaces ( )
inherited

Returns the XML namespace declarations for this XML element.

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

Returns the number of XML namespaces stored in the XMLNamespaces of this XMLToken.

Returns
the number of namespaces in this list.
string libsbmlcs.XMLToken.getNamespaceURI ( int  index)
inherited

Look up the URI of an XML namespace declaration by its position.

Parameters
indexan integer, position of the required URI.
Returns
the URI of an XML namespace declaration in the XMLNamespaces (by position).
Note
If index is out of range, an empty string will be returned.
See Also
getNamespacesLength()
string libsbmlcs.XMLToken.getNamespaceURI ( string  prefix)
inherited

Look up the URI of an XML namespace declaration by its prefix.

Parameters
prefixa string, the prefix of the required URI
Returns
the URI of an XML namespace declaration given its prefix.
Note
If prefix does not exist, an empty string will be returned.
string libsbmlcs.XMLToken.getNamespaceURI ( )
inherited

Look up the URI of an XML namespace declaration by its prefix.

Parameters
prefixa string, the prefix of the required URI
Returns
the URI of an XML namespace declaration given its prefix.
Note
If prefix does not exist, an empty string will be returned.
long libsbmlcs.XMLNode.getNumChildren ( )

Returns the number of children for this XMLNode.

Returns
the number of children for this XMLNode.
string libsbmlcs.XMLToken.getPrefix ( )
inherited

Returns the namespace prefix of this XML element.

Returns
the namespace prefix of this XML element.
Note
If no prefix exists, an empty string will be return.
string libsbmlcs.XMLToken.getURI ( )
inherited

Returns the namespace URI of this XML element.

Returns
the namespace URI of this XML element.
bool libsbmlcs.XMLToken.hasAttr ( int  index)
inherited

Predicate returning true or false depending on whether an attribute with the given index exists in the attribute set in this XMLToken.

Parameters
indexan integer, the position of the attribute.
Returns
true if an attribute with the given index exists in the attribute set in this XMLToken, false otherwise.
bool libsbmlcs.XMLToken.hasAttr ( string  name,
string  uri 
)
inherited

Predicate returning true or false depending on whether an attribute with the given local name and namespace URI exists in the attribute set in this XMLToken.

Parameters
namea string, the local name of the attribute.
uria string, the namespace URI of the attribute.
Returns
true if an attribute with the given local name and namespace URI exists in the attribute set in this XMLToken, false otherwise.
bool libsbmlcs.XMLToken.hasAttr ( string  name)
inherited

Predicate returning true or false depending on whether an attribute with the given local name and namespace URI exists in the attribute set in this XMLToken.

Parameters
namea string, the local name of the attribute.
uria string, the namespace URI of the attribute.
Returns
true if an attribute with the given local name and namespace URI exists in the attribute set in this XMLToken, false otherwise.
bool libsbmlcs.XMLToken.hasAttr ( XMLTriple  triple)
inherited

Predicate returning true or false depending on whether an attribute with the given XML triple exists in the attribute set in this XMLToken.

Parameters
triplean XMLTriple, the XML triple of the attribute
Returns
true if an attribute with the given XML triple exists in the attribute set in this XMLToken, false otherwise.
bool libsbmlcs.XMLNode.hasChild ( string  name)

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

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

Predicate returning true or false depending on whether an XML Namespace with the given uri/prefix pair is contained in the XMLNamespaces ofthis XMLToken.

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 of this XMLToken, false otherwise.
bool libsbmlcs.XMLToken.hasNamespacePrefix ( string  prefix)
inherited

Predicate returning true or false depending on whether an XML Namespace with the given prefix is contained in the XMLNamespaces of this XMLToken.

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

Predicate returning true or false depending on whether an XML Namespace with the given URI is contained in the XMLNamespaces of this XMLToken.

Parameters
uria string, the uri for the namespace
Returns
true if an XML Namespace with the given URI is contained in the XMLNamespaces of this XMLToken, false otherwise.
XMLNode libsbmlcs.XMLNode.insertChild ( long  n,
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 libsbmlcs.XMLToken.isAttributesEmpty ( )
inherited

Predicate returning true or false depending on whether the attribute set in this XMLToken set is empty.

Returns
true if the attribute set in this XMLToken is empty, false otherwise.
bool libsbmlcs.XMLToken.isElement ( )
inherited

Predicate returning true or false depending on whether this XMLToken is an XML element.

Returns
true if this XMLToken is an XML element, false otherwise.
bool libsbmlcs.XMLToken.isEnd ( )
inherited

Predicate returning true or false depending on whether this XMLToken is an XML end element.

Returns
true if this XMLToken is an XML end element, false otherwise.
bool libsbmlcs.XMLToken.isEndFor ( XMLToken  element)
inherited

Predicate returning true or false depending on whether this XMLToken is an XML end element for the given start element.

Parameters
elementXMLToken, element for which query is made.
Returns
true if this XMLToken is an XML end element for the given XMLToken start element, false otherwise.
bool libsbmlcs.XMLToken.isEOF ( )
inherited

Predicate returning true or false depending on whether this XMLToken is an end of file marker.

Returns
true if this XMLToken is an end of file (input) marker, false otherwise.
bool libsbmlcs.XMLToken.isNamespacesEmpty ( )
inherited

Predicate returning true or false depending on whether the XMLNamespaces of this XMLToken is empty.

Returns
true if the XMLNamespaces of this XMLToken is empty, false otherwise.
bool libsbmlcs.XMLToken.isStart ( )
inherited

Predicate returning true or false depending on whether this XMLToken is an XML start element.

Returns
true if this XMLToken is an XML start element, false otherwise.
bool libsbmlcs.XMLToken.isText ( )
inherited

Predicate returning true or false depending on whether this XMLToken is an XML text element.

Returns
true if this XMLToken is an XML text element, false otherwise.
static bool libsbmlcs.XMLToken.operator!= ( XMLToken  lhs,
XMLToken  rhs 
)
staticinherited
static bool libsbmlcs.XMLNode.operator!= ( XMLNode  lhs,
XMLNode  rhs 
)
static
static bool libsbmlcs.XMLToken.operator== ( XMLToken  lhs,
XMLToken  rhs 
)
staticinherited
static bool libsbmlcs.XMLNode.operator== ( XMLNode  lhs,
XMLNode  rhs 
)
static
int libsbmlcs.XMLToken.removeAttr ( int  n)
inherited

Removes an attribute with the given index from the attribute set in this XMLToken.

Nothing will be done if this XMLToken is not a start element.

Parameters
nan integer the index of the resource to be deleted
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.XMLToken.removeAttr ( string  name,
string  uri 
)
inherited

Removes an attribute with the given local name and namespace URI from the attribute set in this XMLToken.

Nothing will be done if this XMLToken is not a start element.

Parameters
namea string, the local name of the attribute.
uria string, the namespace URI of the attribute.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.XMLToken.removeAttr ( string  name)
inherited

Removes an attribute with the given local name and namespace URI from the attribute set in this XMLToken.

Nothing will be done if this XMLToken is not a start element.

Parameters
namea string, the local name of the attribute.
uria string, the namespace URI of the attribute.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.XMLToken.removeAttr ( XMLTriple  triple)
inherited

Removes an attribute with the given XMLTriple from the attribute set in this XMLToken.

Nothing will be done if this XMLToken is not a start element.

Parameters
triplean XMLTriple, the XML triple of the attribute.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
XMLNode libsbmlcs.XMLNode.removeChild ( long  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 libsbmlcs.XMLNode.removeChildren ( )

Removes all children from this node.

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

Removes an XML Namespace stored in the given position of the XMLNamespaces of this XMLToken.

Nothing will be done if this XMLToken is not a start element.

Parameters
indexan integer, position of the removed namespace.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.XMLToken.removeNamespace ( string  prefix)
inherited

Removes an XML Namespace with the given prefix.

Nothing will be done if this XMLToken is not a start element.

Parameters
prefixa string, prefix of the required namespace.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.XMLToken.setAttributes ( XMLAttributes  attributes)
inherited

Sets an XMLAttributes to this XMLToken.

Nothing will be done if this XMLToken is not a start element.

Parameters
attributesXMLAttributes to be set to this XMLToken.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
Note
This function replaces the existing XMLAttributes with the new one.
int libsbmlcs.XMLToken.setEnd ( )
inherited

Declares this XML start element is also an end element.

Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.XMLToken.setEOF ( )
inherited

Declares this XMLToken is an end-of-file (input) marker.

Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.XMLToken.setNamespaces ( XMLNamespaces  namespaces)
inherited

Sets an XMLnamespaces to this XML element.

Nothing will be done if this XMLToken is not a start element.

Parameters
namespacesXMLNamespaces to be set to this XMLToken.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
Note
This function replaces the existing XMLNamespaces with the new one.
int libsbmlcs.XMLToken.setTriple ( XMLTriple  triple)
inherited

Sets the XMLTripe (name, uri and prefix) of this XML element.

Nothing will be done if this XML element is a text node.

Parameters
tripleXMLTriple to be added to this XML element.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
string libsbmlcs.XMLToken.toString ( )
inherited

Prints a string representation of the underlying token stream, for debugging purposes.

string libsbmlcs.XMLNode.toXMLString ( )

Returns a string representation of this XMLNode.

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

Declares this XML start/end element is no longer an end element.

Returns
integer value indicating success/failure of the function. The possible values returned by this function are:

Member Data Documentation

bool libsbmlcs.XMLToken.swigCMemOwn
protectedinherited