libSBML C# API
libSBML 5.8.0 C# API
|
Public Member Functions | |
virtual bool | acceptComp (SWIGTYPE_p_CompVisitor v) |
int | addReplacedElement (ReplacedElement replacedElement) |
virtual void | clearReplacedElements () |
SBasePlugin | clone () |
Creates and returns a deep copy of this SBasePlugin object. More... | |
CompSBasePlugin (string uri, string prefix, CompPkgNamespaces compns) | |
CompSBasePlugin (CompSBasePlugin orig) | |
virtual void | connectToChild () |
void | connectToParent (SBase parent) |
Sets the parent SBML object of this plugin object to this object and child elements (if any). More... | |
virtual SBase | createObject (XMLInputStream stream) |
ReplacedBy | createReplacedBy () |
ReplacedElement | createReplacedElement () |
override void | Dispose () |
void | divideAssignmentsToSIdByFunction (string id, ASTNode function) |
If the function of this object is to assign a value has a child 'math' object (or anything with ASTNodes in general), replace the 'math' object with the function (existing/function). More... | |
void | enablePackageInternal (string pkgURI, string pkgPrefix, bool flag) |
Enables/Disables the given package with child elements in this plugin object (if any). More... | |
long | getColumn () |
Returns the column number on which this object first appears in the XML representation of the SBML document. More... | |
SBase | getElementByMetaId (string metaid) |
Returns the first child element it can find with the given metaid , or null if no such object is found. More... | |
SBase | getElementBySId (string id) |
Returns the first child element found that has the given id in the model-wide SId namespace, or null if no such object is found. More... | |
string | getElementNamespace () |
Returns the XML namespace (URI) of the package extension of this plugin object. More... | |
long | getLevel () |
Returns the SBML level of the package extension of this plugin object. More... | |
long | getLine () |
Returns the line number on which this object first appears in the XML representation of the SBML document. More... | |
SBaseList | getListOfAllElements () |
ListOfReplacedElements | getListOfReplacedElements () |
long | getNumReplacedElements () |
string | getPackageName () |
Returns the package name of this plugin object. More... | |
long | getPackageVersion () |
Returns the package version of the package extension of this plugin object. More... | |
SBase | getParentSBMLObject () |
Returns the parent SBase object to which this plugin object connected. More... | |
string | getPrefix () |
Returns the prefix of the package extension of this plugin object. More... | |
ReplacedBy | getReplacedBy () |
ReplacedElement | getReplacedElement (long n) |
SBMLDocument | getSBMLDocument () |
Returns the parent SBMLDocument of this plugin object. More... | |
SBMLNamespaces | getSBMLNamespaces () |
Returns the column number on which this object first appears in the XML representation of the SBML document. More... | |
string | getURI () |
Gets the URI to which this element belongs to. More... | |
long | getVersion () |
Returns the SBML version of the package extension of this plugin object. More... | |
bool | hasIdentifierBeginningWith (string prefix) |
Check to see if the given prefix is used by any of the IDs defined by extension elements. More... | |
bool | isSetReplacedBy () |
virtual void | logInvalidId (string attribute, string wrongattribute) |
void | logUnknownElement (string element, long sbmlLevel, long sbmlVersion, long pkgVersion) |
Helper to log a common type of error for elements. More... | |
void | multiplyAssignmentsToSIdByFunction (string id, ASTNode function) |
If this assignment assigns a value to the 'id' element, replace the 'math' object with the function (existing*function). More... | |
int | prependStringToAllIdentifiers (string prefix) |
Add the given string to all identifiers in the object. More... | |
ReplacedElement | removeReplacedElement (long index) |
void | replaceSIDWithFunction (string id, ASTNode function) |
If this object has a child 'math' object (or anything with ASTNodes in general), replace all nodes with the name 'id' with the provided function. More... | |
int | setElementNamespace (string uri) |
Sets the XML namespace to which this element belongs to. More... | |
int | setReplacedBy (ReplacedBy replacedBy) |
bool | stripPackage (string pkgPrefix, bool flag) |
Enables/Disables the given package with child elements in this plugin object (if any). More... | |
virtual int | unsetReplacedBy () |
Protected Attributes | |
bool | swigCMemOwn |
libsbmlcs.CompSBasePlugin.CompSBasePlugin | ( | string | uri, |
string | prefix, | ||
CompPkgNamespaces | compns | ||
) |
libsbmlcs.CompSBasePlugin.CompSBasePlugin | ( | CompSBasePlugin | orig | ) |
|
virtual |
Reimplemented in libsbmlcs.CompModelPlugin.
int libsbmlcs.CompSBasePlugin.addReplacedElement | ( | ReplacedElement | replacedElement | ) |
|
virtual |
SBasePlugin libsbmlcs.CompSBasePlugin.clone | ( | ) |
Creates and returns a deep copy of this SBasePlugin object.
|
virtual |
Reimplemented in libsbmlcs.CompModelPlugin.
void libsbmlcs.CompSBasePlugin.connectToParent | ( | SBase | parent | ) |
Sets the parent SBML object of this plugin object to this object and child elements (if any).
(Creates a child-parent relationship by this plugin object)
This function is called when this object is created by the parent element. Subclasses must override this this function if they have one or more child elements. Also, SBasePlugin::connectToParent() must be called in the overridden function.
sbase | the SBase object to use |
|
virtual |
Reimplemented in libsbmlcs.CompModelPlugin.
ReplacedBy libsbmlcs.CompSBasePlugin.createReplacedBy | ( | ) |
ReplacedElement libsbmlcs.CompSBasePlugin.createReplacedElement | ( | ) |
|
virtual |
Reimplemented from libsbmlcs.SBasePlugin.
|
inherited |
If the function of this object is to assign a value has a child 'math' object (or anything with ASTNodes in general), replace the 'math' object with the function (existing/function).
void libsbmlcs.CompSBasePlugin.enablePackageInternal | ( | string | pkgURI, |
string | pkgPrefix, | ||
bool | flag | ||
) |
Enables/Disables the given package with child elements in this plugin object (if any).
(This is an internal implementation invoked from SBase::enablePackageInternal() function)
Subclasses which contain one or more SBase derived elements should override this function if elements defined in them can be extended by some other package extension.
|
inherited |
Returns the column number on which this object first appears in the XML representation of the SBML document.
SBase libsbmlcs.CompSBasePlugin.getElementByMetaId | ( | string | metaid | ) |
Returns the first child element it can find with the given metaid
, or null
if no such object is found.
metaid | string representing the metaid of objects to find |
metaid
. SBase libsbmlcs.CompSBasePlugin.getElementBySId | ( | string | id | ) |
Returns the first child element found that has the given id
in the model-wide SId namespace, or null
if no such object is found.
id | string representing the id of objects to find |
id
.
|
inherited |
Returns the XML namespace (URI) of the package extension of this plugin object.
|
inherited |
Returns the SBML level of the package extension of this plugin object.
|
inherited |
Returns the line number on which this object first appears in the XML representation of the SBML document.
|
inherited |
ListOfReplacedElements libsbmlcs.CompSBasePlugin.getListOfReplacedElements | ( | ) |
long libsbmlcs.CompSBasePlugin.getNumReplacedElements | ( | ) |
|
inherited |
Returns the package name of this plugin object.
|
inherited |
Returns the package version of the package extension of this plugin object.
|
inherited |
|
inherited |
Returns the prefix of the package extension of this plugin object.
ReplacedBy libsbmlcs.CompSBasePlugin.getReplacedBy | ( | ) |
ReplacedElement libsbmlcs.CompSBasePlugin.getReplacedElement | ( | long | n | ) |
|
inherited |
Returns the parent SBMLDocument of this plugin object.
|
inherited |
Returns the column number on which this object first appears in the XML representation of the SBML document.
|
inherited |
Gets the URI to which this element belongs to.
For example, all elements that belong to SBML Level 3 Version 1 Core must would have the URI 'http://www.sbml.org/sbml/level3/version1/core'; all elements that belong to Layout Extension Version 1 for SBML Level 3 Version 1 Core must would have the URI 'http://www.sbml.org/sbml/level3/version1/layout/version1/'
Unlike getElementNamespace, this function first returns the URI for this element by looking into the SBMLNamespaces object of the document with the its package name. if not found it will return the result of getElementNamespace
|
inherited |
Returns the SBML version of the package extension of this plugin object.
|
inherited |
Check to see if the given prefix is used by any of the IDs defined by extension elements.
A package that defines its own 'id' attribute for a core element would check that attribute here.
bool libsbmlcs.CompSBasePlugin.isSetReplacedBy | ( | ) |
|
virtual |
|
inherited |
Helper to log a common type of error for elements.
|
inherited |
If this assignment assigns a value to the 'id' element, replace the 'math' object with the function (existing*function).
|
inherited |
Add the given string to all identifiers in the object.
If the string is added to anything other than an id or a metaid, this code is responsible for tracking down and renaming all *idRefs in the package extention that identifier comes from.
ReplacedElement libsbmlcs.CompSBasePlugin.removeReplacedElement | ( | long | index | ) |
|
inherited |
If this object has a child 'math' object (or anything with ASTNodes in general), replace all nodes with the name 'id' with the provided function.
|
inherited |
Sets the XML namespace to which this element belongs to.
For example, all elements that belong to SBML Level 3 Version 1 Core must set the namespace to 'http://www.sbml.org/sbml/level3/version1/core'; all elements that belong to Layout Extension Version 1 for SBML Level 3 Version 1 Core must set the namespace to 'http://www.sbml.org/sbml/level3/version1/layout/version1/'
int libsbmlcs.CompSBasePlugin.setReplacedBy | ( | ReplacedBy | replacedBy | ) |
|
inherited |
Enables/Disables the given package with child elements in this plugin object (if any).
(This is an internal implementation invoked from SBase::enablePackageInternal() function)
Subclasses which contain one or more SBase derived elements should override this function if elements defined in them can be extended by some other package extension.
|
virtual |
|
protectedinherited |