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

Detailed Description

Class to store SBML level, version and namespace information.

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.

There are differences in the definitions of components between different SBML Levels, as well as Versions within Levels. For example, the 'sboTerm' attribute was not introduced until Level 2 Version 2, and then only on certain component classes; the SBML Level 2 Version 3 specification moved the 'sboTerm' attribute to the SBase class, thereby allowing nearly all components to have SBO annotations. As a result of differences such as those, libSBML needs to track the SBML Level and Version of every object created.

The purpose of the SBMLNamespaces object class is to make it easier to communicate SBML Level and Version data between libSBML constructors and other methods. The SBMLNamespaces object class tracks 3-tuples (triples) consisting of SBML Level, Version, and the corresponding SBML XML namespace.

The plural name (SBMLNamespaces) is not a mistake, because in SBML Level 3, objects may have extensions added by Level 3 packages used by a given model and therefore may have multiple namespaces associated with them; however, until the introduction of SBML Level 3, the SBMLNamespaces object only records one SBML Level/Version/namespace combination at a time. Most constructors for SBML objects in libSBML take a SBMLNamespaces object as an argument, thereby allowing the constructor to produce the proper combination of attributes and other internal data structures for the given SBML Level and Version.

Public Member Functions

int addNamespace (string uri, string prefix)
 Add an XML namespace (a pair of URI and prefix) to the set of namespaces within this SBMLNamespaces object. More...
 
int addNamespaces (XMLNamespaces xmlns)
 Add the given XML namespaces list to the set of namespaces within this SBMLNamespaces object. More...
 
int addPackageNamespace (string pkgName, long pkgVersion, string prefix)
 Add an XML namespace (a pair of URI and prefix) of a package extension to the set of namespaces within this SBMLNamespaces object. More...
 
int addPackageNamespace (string pkgName, long pkgVersion)
 Add an XML namespace (a pair of URI and prefix) of a package extension to the set of namespaces within this SBMLNamespaces object. More...
 
int addPackageNamespaces (XMLNamespaces xmlns)
 Add the XML namespaces of package extensions in the given XMLNamespace object to the set of namespaces within this SBMLNamespaces object (Non-package XML namespaces are not added by this function). More...
 
int addPkgNamespace (string pkgName, long pkgVersion, string prefix)
 Add an XML namespace (a pair of URI and prefix) of a package extension to the set of namespaces within this SBMLNamespaces object. More...
 
int addPkgNamespace (string pkgName, long pkgVersion)
 Add an XML namespace (a pair of URI and prefix) of a package extension to the set of namespaces within this SBMLNamespaces object. More...
 
int addPkgNamespaces (XMLNamespaces xmlns)
 Add the XML namespaces of package extensions in the given XMLNamespace object to the set of namespaces within this SBMLNamespaces object (Non-package XML namespaces are not added by this function). More...
 
SBMLNamespaces clone ()
 Creates and returns a deep copy of this SBMLNamespaces. More...
 
virtual void Dispose ()
 
override bool Equals (Object sb)
 
override int GetHashCode ()
 
long getLevel ()
 Get the SBML Level of this SBMLNamespaces object. More...
 
XMLNamespaces getNamespaces ()
 Get the XML namespaces list for this SBMLNamespaces object. More...
 
string getPackageName ()
 Returns the name of the main package for this namespace. More...
 
string getURI ()
 Returns a string representing the SBML XML namespace of this object. More...
 
long getVersion ()
 Get the SBML Version of this SBMLNamespaces object. More...
 
bool isValidCombination ()
 Predicate returning true if the given set of namespaces represent a valid set. More...
 
int removeNamespace (string uri)
 Removes an XML namespace from the set of namespaces within this SBMLNamespaces object. More...
 
int removePackageNamespace (long level, long version, string pkgName, long pkgVersion)
 Removes an XML namespace of a package extension from the set of namespaces within this SBMLNamespaces object. More...
 
int removePkgNamespace (long level, long version, string pkgName, long pkgVersion)
 Removes an XML namespace of a package extension from the set of namespaces within this SBMLNamespaces object. More...
 
 SBMLNamespaces (long level, long version)
 Creates a new SBMLNamespaces object corresponding to the given SBML level and version. More...
 
 SBMLNamespaces (long level)
 Creates a new SBMLNamespaces object corresponding to the given SBML level and version. More...
 
 SBMLNamespaces ()
 Creates a new SBMLNamespaces object corresponding to the given SBML level and version. More...
 
 SBMLNamespaces (long level, long version, string pkgName, long pkgVersion, string pkgPrefix)
 (For Extension) More...
 
 SBMLNamespaces (long level, long version, string pkgName, long pkgVersion)
 (For Extension) More...
 
 SBMLNamespaces (SBMLNamespaces orig)
 Copy constructor; creates a copy of a SBMLNamespaces. More...
 

Static Public Member Functions

static string getSBMLNamespaceURI (long level, long version)
 Returns a string representing the SBML XML namespace for the given level and version of SBML. More...
 
static SBMLNamespacesList getSupportedNamespaces ()
 Returns a list of all supported SBMLNamespaces in this version of libsbml. More...
 
static bool isSBMLNamespace (string uri)
 Predicate returning true if the given URL is one of SBML XML namespaces. More...
 
static bool operator!= (SBMLNamespaces lhs, SBMLNamespaces rhs)
 
static bool operator== (SBMLNamespaces lhs, SBMLNamespaces rhs)
 

Protected Attributes

bool swigCMemOwn
 

Constructor & Destructor Documentation

libsbmlcs.SBMLNamespaces.SBMLNamespaces ( long  level,
long  version 
)

Creates a new SBMLNamespaces object corresponding to the given SBML level and version.

SBMLNamespaces objects are used in libSBML to communicate SBML Level and Version data between constructors and other methods. The SBMLNamespaces object class tracks 3-tuples (triples) consisting of SBML Level, Version, and the corresponding SBML XML namespace. Most constructors for SBML objects in libSBML take a SBMLNamespaces object as an argument, thereby allowing the constructor to produce the proper combination of attributes and other internal data structures for the given SBML Level and Version.

The plural name (SBMLNamespaces) is not a mistake, because in SBML Level 3, objects may have extensions added by Level 3 packages used by a given model and therefore may have multiple namespaces associated with them; however, until the introduction of SBML Level 3, the SBMLNamespaces object only records one SBML Level/Version/namespace combination at a time. Most constructors for SBML objects in libSBML take a SBMLNamespaces object as an argument, thereby allowing the constructor to produce the proper combination of attributes and other internal data structures for the given SBML Level and Version.

Parameters
levelthe SBML level
versionthe SBML version
libsbmlcs.SBMLNamespaces.SBMLNamespaces ( long  level)

Creates a new SBMLNamespaces object corresponding to the given SBML level and version.

SBMLNamespaces objects are used in libSBML to communicate SBML Level and Version data between constructors and other methods. The SBMLNamespaces object class tracks 3-tuples (triples) consisting of SBML Level, Version, and the corresponding SBML XML namespace. Most constructors for SBML objects in libSBML take a SBMLNamespaces object as an argument, thereby allowing the constructor to produce the proper combination of attributes and other internal data structures for the given SBML Level and Version.

The plural name (SBMLNamespaces) is not a mistake, because in SBML Level 3, objects may have extensions added by Level 3 packages used by a given model and therefore may have multiple namespaces associated with them; however, until the introduction of SBML Level 3, the SBMLNamespaces object only records one SBML Level/Version/namespace combination at a time. Most constructors for SBML objects in libSBML take a SBMLNamespaces object as an argument, thereby allowing the constructor to produce the proper combination of attributes and other internal data structures for the given SBML Level and Version.

Parameters
levelthe SBML level
versionthe SBML version
libsbmlcs.SBMLNamespaces.SBMLNamespaces ( )

Creates a new SBMLNamespaces object corresponding to the given SBML level and version.

SBMLNamespaces objects are used in libSBML to communicate SBML Level and Version data between constructors and other methods. The SBMLNamespaces object class tracks 3-tuples (triples) consisting of SBML Level, Version, and the corresponding SBML XML namespace. Most constructors for SBML objects in libSBML take a SBMLNamespaces object as an argument, thereby allowing the constructor to produce the proper combination of attributes and other internal data structures for the given SBML Level and Version.

The plural name (SBMLNamespaces) is not a mistake, because in SBML Level 3, objects may have extensions added by Level 3 packages used by a given model and therefore may have multiple namespaces associated with them; however, until the introduction of SBML Level 3, the SBMLNamespaces object only records one SBML Level/Version/namespace combination at a time. Most constructors for SBML objects in libSBML take a SBMLNamespaces object as an argument, thereby allowing the constructor to produce the proper combination of attributes and other internal data structures for the given SBML Level and Version.

Parameters
levelthe SBML level
versionthe SBML version
libsbmlcs.SBMLNamespaces.SBMLNamespaces ( long  level,
long  version,
string  pkgName,
long  pkgVersion,
string  pkgPrefix 
)

(For Extension)

Creates a new SBMLNamespaces object corresponding to the combination of (1) the given SBML level and version, and (2) the given package with the package version.

Note
SBMLExtensionException will be thrown if the extension module that supports the combination of the given sbml level, sbml version, package name, and package version has not been registered.
Parameters
levelthe SBML level
versionthe SBML version
pkgNamethe string of package name (e.g. 'layout', 'multi')
pkgVersionthe package version
pkgPrefixthe prefix of the package namespace (e.g. 'layout', 'multi') to be added. The package's name will be used if the given string is empty (default).
libsbmlcs.SBMLNamespaces.SBMLNamespaces ( long  level,
long  version,
string  pkgName,
long  pkgVersion 
)

(For Extension)

Creates a new SBMLNamespaces object corresponding to the combination of (1) the given SBML level and version, and (2) the given package with the package version.

Note
SBMLExtensionException will be thrown if the extension module that supports the combination of the given sbml level, sbml version, package name, and package version has not been registered.
Parameters
levelthe SBML level
versionthe SBML version
pkgNamethe string of package name (e.g. 'layout', 'multi')
pkgVersionthe package version
pkgPrefixthe prefix of the package namespace (e.g. 'layout', 'multi') to be added. The package's name will be used if the given string is empty (default).
libsbmlcs.SBMLNamespaces.SBMLNamespaces ( SBMLNamespaces  orig)

Copy constructor; creates a copy of a SBMLNamespaces.

Parameters
origthe SBMLNamespaces instance to copy.
Exceptions
SBMLConstructorExceptionThrown if the argument orig is null.

Member Function Documentation

int libsbmlcs.SBMLNamespaces.addNamespace ( string  uri,
string  prefix 
)

Add an XML namespace (a pair of URI and prefix) to the set of namespaces within this SBMLNamespaces object.

Parameters
urithe XML namespace to be added.
prefixthe prefix of the namespace to be added.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.SBMLNamespaces.addNamespaces ( XMLNamespaces  xmlns)

Add the given XML namespaces list to the set of namespaces within this SBMLNamespaces object.

The following code gives an example of how one could add the XHTML namespace to the list of namespaces recorded by the top-level <sbml> element of a model. It gives the new namespace a prefix of html. SBMLDocument sd = null; try { sd = new SBMLDocument(3, 1); } catch (SBMLConstructorException e) { // Here, have code to handle a truly exceptional situation. // Candidate causes include invalid combinations of SBML // Level and Version (impossible if hardwired as given here), // running out of memory, and unknown system exceptions. }

XMLNamespaces sn = sd.getNamespaces(); if (sn != null) { sn.add('http://www.w3.org/1999/xhtml', 'html'); } else { // Handle another truly exceptional situation. }

Parameters
xmlnsthe XML namespaces to be added.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.SBMLNamespaces.addPackageNamespace ( string  pkgName,
long  pkgVersion,
string  prefix 
)

Add an XML namespace (a pair of URI and prefix) of a package extension to the set of namespaces within this SBMLNamespaces object.

The SBML Level and SBML Version of this object is used.

Note
An XML namespace of a non-registered package extension can't be added by this function (LIBSBML_INVALID_ATTRIBUTE_VALUE will be returned).
Parameters
pkgNamethe string of package name (e.g. 'layout', 'multi')
pkgVersionthe package version
prefixthe prefix of the package namespace to be added. The package's name will be used if the given string is empty (default).
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
See Also
addNamespace()
int libsbmlcs.SBMLNamespaces.addPackageNamespace ( string  pkgName,
long  pkgVersion 
)

Add an XML namespace (a pair of URI and prefix) of a package extension to the set of namespaces within this SBMLNamespaces object.

The SBML Level and SBML Version of this object is used.

Note
An XML namespace of a non-registered package extension can't be added by this function (LIBSBML_INVALID_ATTRIBUTE_VALUE will be returned).
Parameters
pkgNamethe string of package name (e.g. 'layout', 'multi')
pkgVersionthe package version
prefixthe prefix of the package namespace to be added. The package's name will be used if the given string is empty (default).
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
See Also
addNamespace()
int libsbmlcs.SBMLNamespaces.addPackageNamespaces ( XMLNamespaces  xmlns)

Add the XML namespaces of package extensions in the given XMLNamespace object to the set of namespaces within this SBMLNamespaces object (Non-package XML namespaces are not added by this function).

Note
XML namespaces of a non-registered package extensions are not added (just ignored) by this function. LIBSBML_INVALID_ATTRIBUTE_VALUE will be returned if the given xmlns is null.
Parameters
xmlnsthe XML namespaces to be added.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.SBMLNamespaces.addPkgNamespace ( string  pkgName,
long  pkgVersion,
string  prefix 
)

Add an XML namespace (a pair of URI and prefix) of a package extension to the set of namespaces within this SBMLNamespaces object.

The SBML Level and SBML Version of this object is used.

Note
An XML namespace of a non-registered package extension can't be added by this function (LIBSBML_INVALID_ATTRIBUTE_VALUE will be returned).
Parameters
pkgNamethe string of package name (e.g. 'layout', 'multi')
pkgVersionthe package version
prefixthe prefix of the package namespace to be added. The package's name will be used if the given string is empty (default).
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
See Also
addNamespace()
int libsbmlcs.SBMLNamespaces.addPkgNamespace ( string  pkgName,
long  pkgVersion 
)

Add an XML namespace (a pair of URI and prefix) of a package extension to the set of namespaces within this SBMLNamespaces object.

The SBML Level and SBML Version of this object is used.

Note
An XML namespace of a non-registered package extension can't be added by this function (LIBSBML_INVALID_ATTRIBUTE_VALUE will be returned).
Parameters
pkgNamethe string of package name (e.g. 'layout', 'multi')
pkgVersionthe package version
prefixthe prefix of the package namespace to be added. The package's name will be used if the given string is empty (default).
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
See Also
addNamespace()
int libsbmlcs.SBMLNamespaces.addPkgNamespaces ( XMLNamespaces  xmlns)

Add the XML namespaces of package extensions in the given XMLNamespace object to the set of namespaces within this SBMLNamespaces object (Non-package XML namespaces are not added by this function).

Note
XML namespaces of a non-registered package extensions are not added (just ignored) by this function. LIBSBML_INVALID_ATTRIBUTE_VALUE will be returned if the given xmlns is null.
Parameters
xmlnsthe XML namespaces to be added.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
SBMLNamespaces libsbmlcs.SBMLNamespaces.clone ( )

Creates and returns a deep copy of this SBMLNamespaces.

Returns
a (deep) copy of this SBMLNamespaces.
virtual void libsbmlcs.SBMLNamespaces.Dispose ( )
virtual
override bool libsbmlcs.SBMLNamespaces.Equals ( Object  sb)
override int libsbmlcs.SBMLNamespaces.GetHashCode ( )
long libsbmlcs.SBMLNamespaces.getLevel ( )

Get the SBML Level of this SBMLNamespaces object.

Returns
the SBML Level of this SBMLNamespaces object.
XMLNamespaces libsbmlcs.SBMLNamespaces.getNamespaces ( )

Get the XML namespaces list for this SBMLNamespaces object.

The plural is not a mistake, because in SBML Level 3, objects may have extensions added by Level 3 packages used by a given model, and therefore there may be multiple XML namespaces involved too. However, until the introduction of SBML Level 3, the SBMLNamespaces object only records one SBML Level/Version/namespace combination at a time, and so this method will also only return a list of one item.

Returns
the XML namespaces of this SBMLNamespaces object.
string libsbmlcs.SBMLNamespaces.getPackageName ( )

Returns the name of the main package for this namespace.

Returns
the name of the main package for this namespace. 'core' will be returned if this namespace is defined in the SBML core.
static string libsbmlcs.SBMLNamespaces.getSBMLNamespaceURI ( long  level,
long  version 
)
static

Returns a string representing the SBML XML namespace for the given level and version of SBML.

Parameters
levelthe SBML level
versionthe SBML version
Returns
a string representing the SBML namespace that reflects the SBML Level and Version specified.
Note
Because this is a static method, the non-C++ language interfaces for libSBML will contain two variants. One will be a static method on the class (i.e., SBMLNamespaces), and the other will be a standalone top-level function with the name SBMLNamespaces_getSBMLNamespaceURI(). They are functionally identical.
static SBMLNamespacesList libsbmlcs.SBMLNamespaces.getSupportedNamespaces ( )
static

Returns a list of all supported SBMLNamespaces in this version of libsbml.

Returns
a list with supported SBML namespaces.
Note
Because this is a static method, the non-C++ language interfaces for libSBML will contain two variants. One will be a static method on the class (i.e., SBMLNamespaces), and the other will be a standalone top-level function with the name SBMLNamespaces_getSupportedNamespaces(). They are functionally identical.
string libsbmlcs.SBMLNamespaces.getURI ( )

Returns a string representing the SBML XML namespace of this object.

Returns
a string representing the SBML namespace that reflects the SBML Level and Version of this object.
long libsbmlcs.SBMLNamespaces.getVersion ( )

Get the SBML Version of this SBMLNamespaces object.

Returns
the SBML Version of this SBMLNamespaces object.
static bool libsbmlcs.SBMLNamespaces.isSBMLNamespace ( string  uri)
static

Predicate returning true if the given URL is one of SBML XML namespaces.

Parameters
urithe URI of namespace
Returns
true if the 'uri' is one of SBML namespaces, false otherwise.
Note
Because this is a static method, the non-C++ language interfaces for libSBML will contain two variants. One will be a static method on the class (i.e., SBMLNamespaces), and the other will be a standalone top-level function with the name SBMLNamespaces_isSBMLNamespace(). They are functionally identical.
bool libsbmlcs.SBMLNamespaces.isValidCombination ( )

Predicate returning true if the given set of namespaces represent a valid set.

Returns
true if the set of namespaces is valid, false otherwise.
static bool libsbmlcs.SBMLNamespaces.operator!= ( SBMLNamespaces  lhs,
SBMLNamespaces  rhs 
)
static
static bool libsbmlcs.SBMLNamespaces.operator== ( SBMLNamespaces  lhs,
SBMLNamespaces  rhs 
)
static
int libsbmlcs.SBMLNamespaces.removeNamespace ( string  uri)

Removes an XML namespace from the set of namespaces within this SBMLNamespaces object.

Parameters
urithe XML namespace to be added.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.SBMLNamespaces.removePackageNamespace ( long  level,
long  version,
string  pkgName,
long  pkgVersion 
)

Removes an XML namespace of a package extension from the set of namespaces within this SBMLNamespaces object.

Parameters
levelthe SBML level
versionthe SBML version
pkgNamethe string of package name (e.g. 'layout', 'multi')
pkgVersionthe package version
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int libsbmlcs.SBMLNamespaces.removePkgNamespace ( long  level,
long  version,
string  pkgName,
long  pkgVersion 
)

Removes an XML namespace of a package extension from the set of namespaces within this SBMLNamespaces object.

Parameters
levelthe SBML level
versionthe SBML version
pkgNamethe string of package name (e.g. 'layout', 'multi')
pkgVersionthe package version
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:

Member Data Documentation

bool libsbmlcs.SBMLNamespaces.swigCMemOwn
protected