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

Detailed Description

Representation of a qualified XML name.

This class of objects is defined by libSBML only and has no direct equivalent in terms of SBML components. This class is not prescribed by the SBML specifications, although it is used to implement features defined in SBML.

A 'triple' in the libSBML XML layer encapsulates the notion of qualified name, meaning an element name or an attribute name with an optional namespace qualifier. An XMLTriple instance carries up to three data items:

  • The name of the attribute or element; that is, the attribute name as it appears in an XML document or data stream;

  • The XML namespace prefix (if any) of the attribute. For example, in the following fragment of XML, the namespace prefix is the string mysim and it appears on both the element someelement and the attribute attribA. When both the element and the attribute are stored as XMLTriple objects, their prefix is mysim. <mysim:someelement mysim:attribA='value' />

  • The XML namespace URI with which the prefix is associated. In XML, every namespace used must be declared and mapped to a URI.

XMLTriple objects are the lowest-level data item in the XML layer of libSBML. Other objects such as XMLToken make use of XMLTriple objects.

Public Member Functions

XMLTriple clone ()
 Creates and returns a deep copy of this XMLTriple set. More...
 
virtual void Dispose ()
 
string getName ()
 Returns the name portion of this XMLTriple. More...
 
string getPrefix ()
 Returns the prefix portion of this XMLTriple. More...
 
string getPrefixedName ()
 Returns the prefixed name from this XMLTriple. More...
 
string getURI ()
 Returns the URI portion of this XMLTriple. More...
 
bool isEmpty ()
 Predicate returning true or false depending on whether this XMLTriple is empty. More...
 
 XMLTriple ()
 Creates a new, empty XMLTriple. More...
 
 XMLTriple (string name, string uri, string prefix)
 Creates a new XMLTriple with the given name, uri and and prefix. More...
 
 XMLTriple (string triplet, char sepchar)
 Creates a new XMLTriple by splitting the given triplet on the separator character sepchar. More...
 
 XMLTriple (string triplet)
 Creates a new XMLTriple by splitting the given triplet on the separator character sepchar. More...
 
 XMLTriple (XMLTriple orig)
 Copy constructor; creates a copy of this XMLTriple set. More...
 

Protected Attributes

bool swigCMemOwn
 

Constructor & Destructor Documentation

libsbmlcs.XMLTriple.XMLTriple ( )

Creates a new, empty XMLTriple.

libsbmlcs.XMLTriple.XMLTriple ( string  name,
string  uri,
string  prefix 
)

Creates a new XMLTriple with the given name, uri and and prefix.

Parameters
namea string, name for the XMLTriple.
uria string, URI of the XMLTriple.
prefixa string, prefix for the URI of the XMLTriple,
Exceptions
XMLConstructorExceptionThrown if the argument orig is null.
libsbmlcs.XMLTriple.XMLTriple ( string  triplet,
char  sepchar 
)

Creates a new XMLTriple by splitting the given triplet on the separator character sepchar.

Triplet may be in one of the following formats:

  • name
  • URI sepchar name
  • URI sepchar name sepchar prefix
Parameters
tripleta string representing the triplet as above
sepchara character, the sepchar used in the triplet
Exceptions
XMLConstructorExceptionThrown if the argument orig is null.
libsbmlcs.XMLTriple.XMLTriple ( string  triplet)

Creates a new XMLTriple by splitting the given triplet on the separator character sepchar.

Triplet may be in one of the following formats:

  • name
  • URI sepchar name
  • URI sepchar name sepchar prefix
Parameters
tripleta string representing the triplet as above
sepchara character, the sepchar used in the triplet
Exceptions
XMLConstructorExceptionThrown if the argument orig is null.
libsbmlcs.XMLTriple.XMLTriple ( XMLTriple  orig)

Copy constructor; creates a copy of this XMLTriple set.

Parameters
origthe XMLTriple object to copy.
Exceptions
XMLConstructorExceptionThrown if the argument orig is null.

Member Function Documentation

XMLTriple libsbmlcs.XMLTriple.clone ( )

Creates and returns a deep copy of this XMLTriple set.

Returns
a (deep) copy of this XMLTriple set.
virtual void libsbmlcs.XMLTriple.Dispose ( )
virtual
string libsbmlcs.XMLTriple.getName ( )

Returns the name portion of this XMLTriple.

Returns
a string, the name from this XMLTriple.
string libsbmlcs.XMLTriple.getPrefix ( )

Returns the prefix portion of this XMLTriple.

Returns
a string, the prefix portion of this XMLTriple.
string libsbmlcs.XMLTriple.getPrefixedName ( )

Returns the prefixed name from this XMLTriple.

Returns
a string, the prefixed name from this XMLTriple.
string libsbmlcs.XMLTriple.getURI ( )

Returns the URI portion of this XMLTriple.

Returns
URI a string, the prefix portion of this XMLTriple.
bool libsbmlcs.XMLTriple.isEmpty ( )

Predicate returning true or false depending on whether this XMLTriple is empty.

Returns
true if this XMLTriple is empty, false otherwise.

Member Data Documentation

bool libsbmlcs.XMLTriple.swigCMemOwn
protected