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

Public Member Functions

void addL2Namespaces (XMLNamespaces xmlns)
 adds all L2 Extension namespaces to the namespace list. More...
 
new FbcExtension clone ()
 
override void Dispose ()
 
override SBase DowncastSBase (IntPtr cPtr, bool owner)
 
override SBasePlugin DowncastSBasePlugin (IntPtr cPtr, bool owner)
 
void enableL2NamespaceForDocument (SBMLDocument doc)
 Adds the L2 Namespace to the document and enables the extension. More...
 
 FbcExtension ()
 
 FbcExtension (FbcExtension arg0)
 
long getCategory (long index)
 Determines whether this extension is being used by the given SBMLDocument. More...
 
long getErrorIdOffset ()
 Determines whether this extension is being used by the given SBMLDocument. More...
 
SWIGTYPE_p_packageErrorTableEntry getErrorTable (long index)
 Determines whether this extension is being used by the given SBMLDocument. More...
 
long getErrorTableIndex (long errorId)
 Determines whether this extension is being used by the given SBMLDocument. More...
 
long getLevel (string uri)
 (NOTICE) Package developers MUST OVERRIDE this pure virtual function in their derived class. More...
 
string getMessage (long index, long pkgVersion, string details)
 Determines whether this extension is being used by the given SBMLDocument. More...
 
string getName ()
 (NOTICE) Package developers MUST OVERRIDE this pure virtual function in their derived class. More...
 
int getNumOfSBasePlugins ()
 Returns the number of SBasePlugin objects stored in this object. More...
 
long getNumOfSupportedPackageURI ()
 Returns the number of supported package Namespace (package versions) of this package extension. More...
 
long getPackageVersion (string uri)
 (NOTICE) Package developers MUST OVERRIDE this pure virtual function in their derived class. More...
 
SBMLNamespaces getSBMLExtensionNamespaces (string uri)
 (NOTICE) Package developers MUST OVERRIDE this pure virtual function in their derived class. More...
 
long getSeverity (long index, long pkgVersion)
 Determines whether this extension is being used by the given SBMLDocument. More...
 
string getShortMessage (long index)
 Determines whether this extension is being used by the given SBMLDocument. More...
 
string getStringFromTypeCode (int typeCode)
 (NOTICE) Package developers MUST OVERRIDE this pure virtual function in their derived class. More...
 
string getSupportedPackageURI (long i)
 Returns the ith URI (the supported package version) More...
 
string getURI (long sbmlLevel, long sbmlVersion, long pkgVersion)
 (NOTICE) Package developers MUST OVERRIDE this pure virtual function in their derived class. More...
 
long getVersion (string uri)
 (NOTICE) Package developers MUST OVERRIDE this pure virtual function in their derived class. More...
 
bool isEnabled ()
 Check if this package is enabled (true) or disabled (false). More...
 
bool isInUse (SBMLDocument doc)
 Determines whether this extension is being used by the given SBMLDocument. More...
 
bool isSupported (string uri)
 Returns a flag indicating, whether the given URI (package version) is supported by this package extension. More...
 
void removeL2Namespaces (XMLNamespaces xmlns)
 Removes the L2 Namespaces. More...
 
bool setEnabled (bool isEnabled)
 enable/disable this package. More...
 

Static Public Member Functions

static long getDefaultLevel ()
 
static long getDefaultPackageVersion ()
 
static long getDefaultVersion ()
 
static string getPackageName ()
 
static string getXmlnsL3V1V1 ()
 
static void init ()
 

Protected Attributes

bool swigCMemOwn
 

Constructor & Destructor Documentation

libsbmlcs.FbcExtension.FbcExtension ( )
libsbmlcs.FbcExtension.FbcExtension ( FbcExtension  arg0)

Member Function Documentation

void libsbmlcs.SBMLExtension.addL2Namespaces ( XMLNamespaces  xmlns)
inherited

adds all L2 Extension namespaces to the namespace list.

This method should be overridden by all extensions that want to serialize to an L2 annotation.

new FbcExtension libsbmlcs.FbcExtension.clone ( )
override void libsbmlcs.FbcExtension.Dispose ( )
virtual

Reimplemented from libsbmlcs.SBMLExtension.

override SBase libsbmlcs.FbcExtension.DowncastSBase ( IntPtr  cPtr,
bool  owner 
)
virtual

Reimplemented from libsbmlcs.SBMLExtension.

override SBasePlugin libsbmlcs.FbcExtension.DowncastSBasePlugin ( IntPtr  cPtr,
bool  owner 
)
virtual

Reimplemented from libsbmlcs.SBMLExtension.

void libsbmlcs.SBMLExtension.enableL2NamespaceForDocument ( SBMLDocument  doc)
inherited

Adds the L2 Namespace to the document and enables the extension.

If the extension supports serialization to SBML L2 Annotations, this method should be overrridden, so it will be activated.

long libsbmlcs.SBMLExtension.getCategory ( long  index)
inherited

Determines whether this extension is being used by the given SBMLDocument.

The default implementation returns true. This means that when a document had this extension enabled, it will not be possible to convert it to L2 as we cannot make sure that the extension can be converted.

Parameters
docthe sbml document to test.
Returns
a bool indicating whether the extension is actually being used byy the document.
static long libsbmlcs.FbcExtension.getDefaultLevel ( )
static
static long libsbmlcs.FbcExtension.getDefaultPackageVersion ( )
static
static long libsbmlcs.FbcExtension.getDefaultVersion ( )
static
long libsbmlcs.FbcExtension.getErrorIdOffset ( )

Determines whether this extension is being used by the given SBMLDocument.

The default implementation returns true. This means that when a document had this extension enabled, it will not be possible to convert it to L2 as we cannot make sure that the extension can be converted.

Parameters
docthe sbml document to test.
Returns
a bool indicating whether the extension is actually being used byy the document.
SWIGTYPE_p_packageErrorTableEntry libsbmlcs.FbcExtension.getErrorTable ( long  index)

Determines whether this extension is being used by the given SBMLDocument.

The default implementation returns true. This means that when a document had this extension enabled, it will not be possible to convert it to L2 as we cannot make sure that the extension can be converted.

Parameters
docthe sbml document to test.
Returns
a bool indicating whether the extension is actually being used byy the document.
long libsbmlcs.FbcExtension.getErrorTableIndex ( long  errorId)

Determines whether this extension is being used by the given SBMLDocument.

The default implementation returns true. This means that when a document had this extension enabled, it will not be possible to convert it to L2 as we cannot make sure that the extension can be converted.

Parameters
docthe sbml document to test.
Returns
a bool indicating whether the extension is actually being used byy the document.
long libsbmlcs.FbcExtension.getLevel ( string  uri)

(NOTICE) Package developers MUST OVERRIDE this pure virtual function in their derived class.

Returns the SBML level associated with the given URI of this package.

Parameters
urithe string of URI that represents a versions of the package
Returns
the SBML level associated with the given URI of this package.
string libsbmlcs.SBMLExtension.getMessage ( long  index,
long  pkgVersion,
string  details 
)
inherited

Determines whether this extension is being used by the given SBMLDocument.

The default implementation returns true. This means that when a document had this extension enabled, it will not be possible to convert it to L2 as we cannot make sure that the extension can be converted.

Parameters
docthe sbml document to test.
Returns
a bool indicating whether the extension is actually being used byy the document.
string libsbmlcs.FbcExtension.getName ( )

(NOTICE) Package developers MUST OVERRIDE this pure virtual function in their derived class.

Returns the name of this package (e.g. 'layout', 'multi').

Returns
the name of package extension
int libsbmlcs.SBMLExtension.getNumOfSBasePlugins ( )
inherited

Returns the number of SBasePlugin objects stored in this object.

Returns
the number of SBasePlugin objects stored in this object.
long libsbmlcs.SBMLExtension.getNumOfSupportedPackageURI ( )
inherited

Returns the number of supported package Namespace (package versions) of this package extension.

Returns
the number of supported package Namespace (package versions) of this package extension.
static string libsbmlcs.FbcExtension.getPackageName ( )
static
long libsbmlcs.FbcExtension.getPackageVersion ( string  uri)

(NOTICE) Package developers MUST OVERRIDE this pure virtual function in their derived class.

Returns the package version associated with the given URI of this package.

Parameters
urithe string of URI that represents a versions of this package
Returns
the package version associated with the given URI of this package.
SBMLNamespaces libsbmlcs.FbcExtension.getSBMLExtensionNamespaces ( string  uri)

(NOTICE) Package developers MUST OVERRIDE this pure virtual function in their derived class.

Returns an SBMLExtensionNamespaces<class SBMLExtensionType> object (e.g. SBMLExtensionNamespaces<LayoutExtension> whose alias type is LayoutPkgNamespaces) corresponding to the given uri. Null will be returned if the given uri is not defined in the corresponding package.

Parameters
urithe string of URI that represents one of versions of the package
Returns
an SBMLExtensionNamespaces<class SBMLExtensionType> object. null will be returned if the given uri is not defined in the corresponding package.
long libsbmlcs.SBMLExtension.getSeverity ( long  index,
long  pkgVersion 
)
inherited

Determines whether this extension is being used by the given SBMLDocument.

The default implementation returns true. This means that when a document had this extension enabled, it will not be possible to convert it to L2 as we cannot make sure that the extension can be converted.

Parameters
docthe sbml document to test.
Returns
a bool indicating whether the extension is actually being used byy the document.
string libsbmlcs.SBMLExtension.getShortMessage ( long  index)
inherited

Determines whether this extension is being used by the given SBMLDocument.

The default implementation returns true. This means that when a document had this extension enabled, it will not be possible to convert it to L2 as we cannot make sure that the extension can be converted.

Parameters
docthe sbml document to test.
Returns
a bool indicating whether the extension is actually being used byy the document.
string libsbmlcs.FbcExtension.getStringFromTypeCode ( int  typeCode)

(NOTICE) Package developers MUST OVERRIDE this pure virtual function in their derived class.

This method takes a type code of this package and returns a string representing the code.

string libsbmlcs.SBMLExtension.getSupportedPackageURI ( long  i)
inherited

Returns the ith URI (the supported package version)

Parameters
ithe index of the list of URI (the list of supporeted pacakge versions)
Returns
the URI of supported package version with the given index.
string libsbmlcs.FbcExtension.getURI ( long  sbmlLevel,
long  sbmlVersion,
long  pkgVersion 
)

(NOTICE) Package developers MUST OVERRIDE this pure virtual function in their derived class.

Returns the uri corresponding to the given SBML level, SBML version, and package version.

Parameters
sbmlLevelthe level of SBML
sbmlVersionthe version of SBML
pkgVersionthe version of package
Returns
a string of the package URI
long libsbmlcs.FbcExtension.getVersion ( string  uri)

(NOTICE) Package developers MUST OVERRIDE this pure virtual function in their derived class.

Returns the SBML version associated with the given URI of this package.

Parameters
urithe string of URI that represents a versions of the package
Returns
the SBML version associated with the given URI of this package.
static string libsbmlcs.FbcExtension.getXmlnsL3V1V1 ( )
static
static void libsbmlcs.FbcExtension.init ( )
static
bool libsbmlcs.SBMLExtension.isEnabled ( )
inherited

Check if this package is enabled (true) or disabled (false).

Returns
true if this package is enabled, otherwise false is returned.
bool libsbmlcs.SBMLExtension.isInUse ( SBMLDocument  doc)
inherited

Determines whether this extension is being used by the given SBMLDocument.

The default implementation returns true. This means that when a document had this extension enabled, it will not be possible to convert it to L2 as we cannot make sure that the extension can be converted.

Parameters
docthe sbml document to test.
Returns
a bool indicating whether the extension is actually being used byy the document.
bool libsbmlcs.SBMLExtension.isSupported ( string  uri)
inherited

Returns a flag indicating, whether the given URI (package version) is supported by this package extension.

Returns
true if the given URI (package version) is supported by this package extension, otherwise false is returned.
void libsbmlcs.SBMLExtension.removeL2Namespaces ( XMLNamespaces  xmlns)
inherited

Removes the L2 Namespaces.

This method should be overridden by all extensions that want to serialize to an L2 annotation.

bool libsbmlcs.SBMLExtension.setEnabled ( bool  isEnabled)
inherited

enable/disable this package.

Returned value is the result of this function.

Parameters
isEnabledthe bool value: true (enabled) or false (disabled)
Returns
true if this function call succeeded, otherwise false is returned.

Member Data Documentation

bool libsbmlcs.SBMLExtension.swigCMemOwn
protectedinherited