public class RenderPkgNamespaces extends SBMLNamespaces
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.
SBMLExtensionNamespaces
is a template class. It is extended from
SBMLNamespaces
and is meant to be used by package extensions to store the
SBML Level, Version within a Level, and package version of the SBML
Level 3 package implemented by a libSBML package extension.
SBML Level 3's package structure permits modular extensions to the core SBML format. In libSBML, support for SBML Level 3 packages is provided through optional package extensions that can be plugged into libSBML at the time it is built/compiled. Users of libSBML can thus choose which extensions are enabled in their software applications.
LibSBML defines a number of classes that developers of package extensions
can use to implement support for an SBML Level 3 package. These
classes make it easier to extend libSBML objects with new attributes
and/or subobjects as needed by a particular Level 3 package.
Three overall categories of classes make up libSBML's facilities for
implementing package extensions. There are (1) classes that serve as base
classes meant to be subclassed, (2) template classes meant to be
instantiated rather than subclassed, and (3) support classes that provide
utility features. A given package implementation for libSBML will take
the form of code using these and other libSBML classes, placed in a
subdirectory of src/sbml/packages/
.
The basic libSBML distribution includes a number of package extensions implementing support for officially-endorsed SBML Level 3 packages among these are Flux Balance Constraints ('fbc'), Hierarchical Model Composition ('comp'), Layout ('layout'), and Qualitative Models ('qual'). They can serve as working examples for developers working to implement other packages.
Extensions in libSBML can currently only be implemented in C++ or C there is no mechanism to implement them first in languages such as Java or Python. However, once implemented in C++ or C, language interfaces can be generated semi-automatically using the framework in place in libSBML. (The approach is based on using SWIG and facilities in libSBML's build system.)
Constructor and Description |
---|
RenderPkgNamespaces()   |
RenderPkgNamespaces(long level)   |
RenderPkgNamespaces(long level,
long version)   |
RenderPkgNamespaces(long level,
long version,
long pkgVersion)   |
RenderPkgNamespaces(long level,
long version,
long pkgVersion,
String prefix)   |
RenderPkgNamespaces(RenderPkgNamespaces orig)   |
Modifier and Type | Method and Description |
---|---|
SBMLNamespaces |
cloneObject()
Creates and returns a deep copy of this
SBMLNamespaces object. |
void |
delete()
Explicitly deletes the underlying native object.
|
String |
getPackageName()
Returns the name of the main package for this namespace.
|
long |
getPackageVersion()   |
String |
getURI()
Returns a string representing the SBML XML namespace of this
object.
|
addNamespace, addNamespaces, addPackageNamespace, addPackageNamespace, addPackageNamespaces, equals, freeSBMLNamespaces, getLevel, getNamespaces, getSBMLNamespaceURI, getSupportedNamespaces, getVersion, hashCode, isSBMLNamespace, isValidCombination, removeNamespace, removePackageNamespace
public RenderPkgNamespaces(long level, long version, long pkgVersion, String prefix) throws SBMLConstructorException
SBMLConstructorException
public RenderPkgNamespaces(long level, long version, long pkgVersion) throws SBMLConstructorException
SBMLConstructorException
public RenderPkgNamespaces(long level, long version) throws SBMLConstructorException
SBMLConstructorException
public RenderPkgNamespaces(long level) throws SBMLConstructorException
SBMLConstructorException
public RenderPkgNamespaces() throws SBMLConstructorException
SBMLConstructorException
public RenderPkgNamespaces(RenderPkgNamespaces orig) throws SBMLConstructorException
SBMLConstructorException
public void delete()
In general, application software will not need to call this method directly. The Java language binding for libSBML is implemented as a language wrapper that provides a Java interface to libSBML's underlying C++/C code. Some of the Java methods return objects that are linked to objects created not by Java code, but by C++ code. The Java objects wrapped around them will be deleted when the garbage collector invokes the corresponding C++ finalize()
methods for the objects. The finalize()
methods in turn call the RenderPkgNamespaces.delete()
method on the libSBML object.
This method is exposed in case calling programs want to ensure that the underlying object is freed immediately, and not at some arbitrary time determined by the Java garbage collector. In normal usage, callers do not need to invoke RenderPkgNamespaces.delete()
themselves.
delete
 in class SBMLNamespaces
public SBMLNamespaces cloneObject()
SBMLNamespaces
object.
cloneObject
 in class SBMLNamespaces
SBMLNamespaces
object.public String getURI()
getURI
 in class SBMLNamespaces
public long getPackageVersion()
public String getPackageName()
getPackageName
 in class SBMLNamespaces