libSBML C# API
libSBML 5.8.0 C# API
|
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 |
libsbmlcs.FbcExtension.FbcExtension | ( | ) |
libsbmlcs.FbcExtension.FbcExtension | ( | FbcExtension | arg0 | ) |
|
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 | ( | ) |
|
virtual |
Reimplemented from libsbmlcs.SBMLExtension.
|
virtual |
Reimplemented from libsbmlcs.SBMLExtension.
|
virtual |
Reimplemented from libsbmlcs.SBMLExtension.
|
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.
|
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.
doc | the sbml document to test. |
|
static |
|
static |
|
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.
doc | the sbml document to test. |
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.
doc | the sbml document to test. |
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.
doc | the sbml document to test. |
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.
uri | the string of URI that represents a versions of the package |
|
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.
doc | the sbml document to test. |
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').
|
inherited |
Returns the number of SBasePlugin objects stored in this object.
|
inherited |
Returns the number of supported package Namespace (package versions) of this package extension.
|
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.
uri | the string of URI that represents a versions 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.
uri | the string of URI that represents one of versions of the package |
|
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.
doc | the sbml document to test. |
|
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.
doc | the sbml document to test. |
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.
|
inherited |
Returns the ith URI (the supported package version)
i | the index of the list of URI (the list of supporeted pacakge versions) |
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.
sbmlLevel | the level of SBML |
sbmlVersion | the version of SBML |
pkgVersion | the version of package |
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.
uri | the string of URI that represents a versions of the package |
|
static |
|
static |
|
inherited |
Check if this package is enabled (true) or disabled (false).
|
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.
doc | the sbml document to test. |
|
inherited |
Returns a flag indicating, whether the given URI (package version) is supported by this package extension.
|
inherited |
Removes the L2 Namespaces.
This method should be overridden by all extensions that want to serialize to an L2 annotation.
|
inherited |
enable/disable this package.
Returned value is the result of this function.
isEnabled | the bool value: true (enabled) or false (disabled) |
|
protectedinherited |