libSBML C# API
libSBML 5.8.0 C# API
|
Implementation of SBML's Unit construct.
The SBML unit definition facility uses two classes of objects, UnitDefinition and Unit. The approach to defining units in SBML is compositional; for example, meter second –2 is constructed by combining a Unit object representing meter with another Unit object representing second –2. The combination is wrapped inside a UnitDefinition, which provides for assigning an identifier and optional name to the combination. The identifier can then be referenced from elsewhere in a model. Thus, the UnitDefinition class is the container, and Unit instances are placed inside UnitDefinition instances.
A Unit structure has four attributes named 'kind', 'exponent', 'scale' and 'multiplier'. It represents a (possibly transformed) reference to a base unit. The attribute 'kind' on Unit indicates the chosen base unit. Its value must be one of the text strings listed below; this list corresponds to SBML Level 3 Version 1 Core:
ampere | farad | joule | lux | radian | volt |
avogadro | gram | katal | metre | second | watt |
becquerel | gray | kelvin | mole | siemens | weber |
candela | henry | kilogram | newton | sievert | |
coulomb | hertz | litre | ohm | steradian | |
dimensionless | item | lumen | pascal | tesla |
A few small differences exist between the Level 3 list of base units and the list defined in other Level/Version combinations of SBML. Specifically, Levels of SBML before Level 3 do not define avogadro
; conversely, Level 2 Version 1 defines Celsius
, and Level 1 defines celsius
, meter
, and liter
, none of which are available in Level 3. In libSBML, each of the predefined base unit names is represented by an enumeration value whose name begins with the characters UNIT_KIND_
, discussed in a separate section below.
The attribute named 'exponent' on Unit represents an exponent on the unit. In SBML Level 2, the attribute is optional and has a default value of 1
(one); in SBML Level 3, the attribute is mandatory and there is no default value. A Unit structure also has an attribute called 'scale'; its value must be an integer exponent for a power-of-ten multiplier used to set the scale of the unit. For example, a unit having a 'kind' value of gram
and a 'scale' value of -3
signifies 10 –3 * gram, or milligrams. In SBML Level 2, the attribute is optional and has a default value of 0
(zero), because 10 0 = 1; in SBML Level 3, the attribute is mandatory and has no default value. Lastly, the attribute named 'multiplier' can be used to multiply the unit by a real-numbered factor; this enables the definition of units that are not power-of-ten multiples of SI units. For instance, a multiplier of 0.3048 could be used to define foot
as a measure of length in terms of a metre
. The 'multiplier' attribute is optional in SBML Level 2, where it has a default value of 1
(one); in SBML Level 3, the attribute is mandatory and has not default value.
As discussed above, SBML defines a set of base units which serves as the starting point for new unit definitions. This set of base units consists of the SI units and a small number of additional convenience units.
As a consequence of the fact that libSBML supports models in all Levels and Versions of SBML, libSBML's set of UNIT_KIND_
values is a union of all the possible base unit names defined in the different SBML specifications. However, not every base unit is allowed in every Level+Version combination of SBML. Note in particular the following exceptions:
The alternate spelling 'meter'
is included in addition to the official SI spelling 'metre'
. This spelling is only permitted in SBML Level 1 models.
The alternate spelling 'liter'
is included in addition to the official SI spelling 'litre'
. This spelling is only permitted in SBML Level 1 models.
The unit 'Celsius'
is included because of its presence in specifications of SBML prior to SBML Level 2 Version 3.
avogadro
was introduced in SBML Level 3, and is only permitted for use in SBML Level 3 models. The table below lists the unit constants defined in libSBML, and their meanings.
Enumerator | Meaning |
---|---|
UNIT_KIND_AMPERE | The ampere unit. |
UNIT_KIND_AVOGADRO | The unit
dimensionless multiplied by the numerical value of Avogadro's
constant. (Only usable in SBML Level 3 models.) |
UNIT_KIND_BECQUEREL | The becquerel unit. |
UNIT_KIND_CANDELA | The candela unit. |
UNIT_KIND_CELSIUS | The Celsius unit. (Only usable in SBML Level 1 and SBML Level 2 Version 1 models.) |
UNIT_KIND_COULOMB | The coulomb unit. |
UNIT_KIND_DIMENSIONLESS | A pseudo-unit indicating a dimensionless quantity. |
UNIT_KIND_FARAD | The farad unit. |
UNIT_KIND_GRAM | The gram unit. |
UNIT_KIND_GRAY | The gray unit. |
UNIT_KIND_HENRY | The henry unit. |
UNIT_KIND_HERTZ | The hertz unit. |
UNIT_KIND_ITEM | A pseudo-unit representing a single "thing". |
UNIT_KIND_JOULE | The joule unit. |
UNIT_KIND_KATAL | The katal unit. |
UNIT_KIND_KELVIN | The kelvin unit. |
UNIT_KIND_KILOGRAM | The kilogram unit. |
UNIT_KIND_LITER | Alternate spelling of litre. |
UNIT_KIND_LITRE | The litre unit. |
UNIT_KIND_LUMEN | The lumen unit. |
UNIT_KIND_LUX | The lux unit. |
UNIT_KIND_METER | Alternate spelling of metre. |
UNIT_KIND_METRE | The metre unit. |
UNIT_KIND_MOLE | The mole unit. |
UNIT_KIND_NEWTON | The newton unit. |
UNIT_KIND_OHM | The ohm unit. |
UNIT_KIND_PASCAL | The pascal unit. |
UNIT_KIND_RADIAN | The radian unit. |
UNIT_KIND_SECOND | The second unit. |
UNIT_KIND_SIEMENS | The siemens unit. |
UNIT_KIND_SIEVERT | The sievert unit. |
UNIT_KIND_STERADIAN | The steradian unit. |
UNIT_KIND_TESLA | The tesla unit. |
UNIT_KIND_VOLT | The volt unit. |
UNIT_KIND_WATT | The watt unit. |
UNIT_KIND_WEBER | The weber unit. |
UNIT_KIND_INVALID | Marker used by libSBML to indicate an invalid or unset unit. |
Public Member Functions | |
int | addCVTerm (CVTerm term, bool newBag) |
Adds a copy of the given CVTerm object to this SBML object. More... | |
int | addCVTerm (CVTerm term) |
Adds a copy of the given CVTerm object to this SBML object. More... | |
int | appendAnnotation (XMLNode annotation) |
Appends the given annotation to the 'annotation' subelement of this object. More... | |
int | appendAnnotation (string annotation) |
Appends the given annotation to the 'annotation' subelement of this object. More... | |
int | appendNotes (XMLNode notes) |
Appends the given notes to the 'notes' subelement of this object. More... | |
int | appendNotes (string notes) |
Appends the given notes to the 'notes' subelement of this object. More... | |
int | checkCompatibility (SBase arg0) |
Subclasses should override this method to write out their contained SBML objects as XML elements. More... | |
string | checkMathMLNamespace (XMLToken elem) |
Subclasses should override this method to write out their contained SBML objects as XML elements. More... | |
new Unit | clone () |
Creates and returns a deep copy of this Unit. More... | |
void | connectToChild () |
Sets this SBML object to child SBML objects (if any). More... | |
void | connectToParent (SBase parent) |
Sets the parent SBML object of this SBML object. More... | |
int | disablePackage (string pkgURI, string pkgPrefix) |
Disables the given SBML Level 3 package. More... | |
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... | |
int | enablePackage (string pkgURI, string pkgPrefix, bool flag) |
Enables or disables the given SBML Level 3 package. More... | |
void | enablePackageInternal (string pkgURI, string pkgPrefix, bool flag) |
Enables/Disables the given package with this element and child elements (if any). More... | |
override bool | Equals (Object sb) |
SBase | getAncestorOfType (int type, string pkgName) |
Returns the first ancestor object that has the given SBML type code. More... | |
SBase | getAncestorOfType (int type) |
Returns the first ancestor object that has the given SBML type code. More... | |
XMLNode | getAnnotation () |
Returns the content of the 'annotation' subelement of this object as a tree of XMLNode objects. More... | |
string | getAnnotationString () |
Returns the content of the 'annotation' subelement of this object as a character string. More... | |
long | getColumn () |
Returns the column number on which this object first appears in the XML representation of the SBML document. More... | |
CVTerm | getCVTerm (long n) |
Returns the nth CVTerm in the list of CVTerms of this SBML object. More... | |
CVTermList | getCVTerms () |
Returns a list of CVTerm objects in the annotations of this SBML object. More... | |
SBase | getElementByMetaId (string metaid) |
Returns the first child element it can find with a specific 'metaid' attribute value, 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... | |
SBase | getElementFromPluginsByMetaId (string metaid) |
Returns the first child element it can find with the given metaid from all plug-ins associated with this element, or null if no such object is found. More... | |
SBase | getElementFromPluginsBySId (string id) |
Returns the first child element found that has the given id in the model-wide SId namespace from all plug-ins associated with this element, or null if no such object is found. More... | |
new string | getElementName () |
Returns the XML element name of this object, which for Unit, is always 'unit' . More... | |
int | getExponent () |
Returns the value of the 'exponent' attribute of this unit. More... | |
double | getExponentAsDouble () |
Returns the value of the 'exponent' attribute of this unit. More... | |
override int | GetHashCode () |
string | getId () |
Returns the value of the 'metaid' attribute of this object. More... | |
int | getKind () |
Returns the 'kind' of Unit this is. More... | |
long | getLevel () |
Returns the SBML Level of the SBMLDocument object containing this 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 () |
SBaseList | getListOfAllElementsFromPlugins () |
string | getMetaId () |
Returns the value of the 'metaid' attribute of this object. More... | |
Model | getModel () |
Returns the Model object in which the current object is located. More... | |
ModelHistory | getModelHistory () |
Returns the ModelHistory object, if any, attached to this object. More... | |
double | getMultiplier () |
Returns the value of the 'multiplier' attribute of this Unit. More... | |
string | getName () |
Returns the value of the 'metaid' attribute of this object. More... | |
XMLNamespaces | getNamespaces () |
Returns a list of the XML Namespaces declared on this SBML document. More... | |
XMLNode | getNotes () |
Returns the content of the 'notes' subelement of this object as a tree of XMLNode objects. More... | |
string | getNotesString () |
Returns the content of the 'notes' subelement of this object as a string. More... | |
long | getNumCVTerms () |
Returns the number of CVTerm objects in the annotations of this SBML object. More... | |
long | getNumPlugins () |
Returns the number of plug-in objects (extenstion interfaces) for SBML Level 3 package extensions known. More... | |
double | getOffset () |
Returns the value of the 'offset' attribute of this Unit. More... | |
string | getPackageName () |
Returns the name of the SBML Level 3 package in which this element is defined. More... | |
long | getPackageVersion () |
Returns the Version of the SBML Level 3 package to which this element belongs to. More... | |
SBase | getParentSBMLObject () |
Returns the parent SBML object containing this object. More... | |
SBasePlugin | getPlugin (string package) |
Returns a plug-in object (extension interface) for an SBML Level 3 package extension with the given package name or URI. More... | |
SBasePlugin | getPlugin (long n) |
Returns the nth plug-in object (extension interface) for an SBML Level 3 package extension. More... | |
int | getResourceBiologicalQualifier (string resource) |
Returns the MIRIAM biological qualifier associated with the given resource. More... | |
int | getResourceModelQualifier (string resource) |
Returns the MIRIAM model qualifier associated with the given resource. More... | |
SBMLDocument | getSBMLDocument () |
Returns the SBMLDocument object containing this object instance. More... | |
SBMLNamespaces | getSBMLNamespaces () |
Subclasses should override this method to write out their contained SBML objects as XML elements. More... | |
int | getSBOTerm () |
Returns the integer portion of the value of the 'sboTerm' attribute of this object. More... | |
string | getSBOTermAsURL () |
Returns the identifiers.org URL representation of the 'sboTerm' attribute of this object. More... | |
string | getSBOTermID () |
Returns the string representation of the 'sboTerm' attribute of this object. More... | |
int | getScale () |
Returns the value of the 'scale' attribute of this unit. More... | |
new int | getTypeCode () |
Returns the libSBML type code of this object instance. More... | |
long | getVersion () |
Returns the Version within the SBML Level of the SBMLDocument object containing this object. More... | |
bool | hasNonstandardIdentifierBeginningWith (string prefix) |
Check to see if the given prefix is used by any of the IDs defined by extension elements *excluding* 'id' and 'metaid' attributes (as, for example, the spatial id attributes 'spid'). More... | |
new bool | hasRequiredAttributes () |
Predicate returning true if all the required attributes for this Unit object have been set. More... | |
bool | hasRequiredElements () |
Subclasses should override this method to write out their contained SBML objects as XML elements. More... | |
bool | hasValidLevelVersionNamespaceCombination () |
Predicate returning true if this object's level/version and namespace values correspond to a valid SBML specification. More... | |
void | initDefaults () |
Initializes the fields of this Unit object to 'typical' default values. More... | |
bool | isAmpere () |
Predicate for testing whether this Unit is of the kind ampere . More... | |
bool | isAvogadro () |
Predicate for testing whether this Unit is of the kind avogadro . More... | |
bool | isBecquerel () |
Predicate for testing whether this Unit is of the kind becquerel . More... | |
bool | isCandela () |
Predicate for testing whether this Unit is of the kind candela . More... | |
bool | isCelsius () |
Predicate for testing whether this Unit is of the kind Celsius . More... | |
bool | isCoulomb () |
Predicate for testing whether this Unit is of the kind coulomb . More... | |
bool | isDimensionless () |
Predicate for testing whether this Unit is of the kind dimensionless . More... | |
bool | isFarad () |
Predicate for testing whether this Unit is of the kind farad . More... | |
bool | isGram () |
Predicate for testing whether this Unit is of the kind gram . More... | |
bool | isGray () |
Predicate for testing whether this Unit is of the kind gray . More... | |
bool | isHenry () |
Predicate for testing whether this Unit is of the kind henry . More... | |
bool | isHertz () |
Predicate for testing whether this Unit is of the kind hertz . More... | |
bool | isItem () |
Predicate for testing whether this Unit is of the kind item . More... | |
bool | isJoule () |
Predicate for testing whether this Unit is of the kind joule . More... | |
bool | isKatal () |
Predicate for testing whether this Unit is of the kind katal . More... | |
bool | isKelvin () |
Predicate for testing whether this Unit is of the kind kelvin . More... | |
bool | isKilogram () |
Predicate for testing whether this Unit is of the kind kilogram . More... | |
bool | isLitre () |
Predicate for testing whether this Unit is of the kind litre . More... | |
bool | isLumen () |
Predicate for testing whether this Unit is of the kind lumen . More... | |
bool | isLux () |
Predicate for testing whether this Unit is of the kind lux . More... | |
bool | isMetre () |
Predicate for testing whether this Unit is of the kind metre . More... | |
bool | isMole () |
Predicate for testing whether this Unit is of the kind mole . More... | |
bool | isNewton () |
Predicate for testing whether this Unit is of the kind newton . More... | |
bool | isOhm () |
Predicate for testing whether this Unit is of the kind ohm . More... | |
bool | isPackageEnabled (string pkgName) |
Predicate returning true if the given SBML Level 3 package is enabled with this object. More... | |
bool | isPackageURIEnabled (string pkgURI) |
Predicate returning true if an SBML Level 3 package with the given URI is enabled with this object. More... | |
bool | isPascal () |
Predicate for testing whether this Unit is of the kind pascal . More... | |
bool | isPkgEnabled (string pkgName) |
Predicate returning true if the given SBML Level 3 package is enabled with this object. More... | |
bool | isPkgURIEnabled (string pkgURI) |
Predicate returning true if an SBML Level 3 package with the given URI is enabled with this object. More... | |
bool | isRadian () |
Predicate for testing whether this Unit is of the kind radian . More... | |
bool | isSecond () |
Predicate for testing whether this Unit is of the kind second . More... | |
bool | isSetAnnotation () |
Predicate returning true if this object's 'annotation' subelement exists and has content. More... | |
bool | isSetExponent () |
Predicate to test whether the 'exponent' attribute of this Unit is set. More... | |
bool | isSetId () |
Predicate returning true if this object's 'metaid' attribute is set. More... | |
bool | isSetKind () |
Predicate to test whether the 'kind' attribute of this Unit is set. More... | |
bool | isSetMetaId () |
Predicate returning true if this object's 'metaid' attribute is set. More... | |
bool | isSetModelHistory () |
Predicate returning true if this object has a ModelHistory object attached to it. More... | |
bool | isSetMultiplier () |
Predicate to test whether the 'multiplier' attribute of this Unit is set. More... | |
bool | isSetName () |
Predicate returning true if this object's 'metaid' attribute is set. More... | |
bool | isSetNotes () |
Predicate returning true if this object's 'notes' subelement exists and has content. More... | |
bool | isSetSBOTerm () |
Predicate returning true if this object's 'sboTerm' attribute is set. More... | |
bool | isSetScale () |
Predicate to test whether the 'scale' attribute of this Unit is set. More... | |
bool | isSiemens () |
Predicate for testing whether this Unit is of the kind siemens . More... | |
bool | isSievert () |
Predicate for testing whether this Unit is of the kind sievert . More... | |
bool | isSteradian () |
Predicate for testing whether this Unit is of the kind steradian . More... | |
bool | isTesla () |
Predicate for testing whether this Unit is of the kind tesla . More... | |
bool | isVolt () |
Predicate for testing whether this Unit is of the kind volt . More... | |
bool | isWatt () |
Predicate for testing whether this Unit is of the kind watt . More... | |
bool | isWeber () |
Predicate for testing whether this Unit is of the kind weber . More... | |
bool | matchesRequiredSBMLNamespacesForAddition (SBase sb) |
Returns true if this object's set of XML namespaces are a subset of the given object's XML namespaces. More... | |
bool | matchesSBMLNamespaces (SBase sb) |
Returns true if this object's set of XML namespaces are the same as the given object's XML namespaces. 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... | |
int | removeFromParentAndDelete () |
Removes itself from its parent. More... | |
int | removeTopLevelAnnotationElement (string elementName, string elementURI) |
Removes the top-level element within the 'annotation' subelement of this SBML object with the given name and optional URI. More... | |
int | removeTopLevelAnnotationElement (string elementName) |
Removes the top-level element within the 'annotation' subelement of this SBML object with the given name and optional URI. More... | |
void | renameMetaIdRefs (string oldid, string newid) |
Renames all the MetaIdRef attributes on this element. More... | |
void | renameSIdRefs (string oldid, string newid) |
Renames all the SIdRef attributes on this element, including any found in MathML content (if such exists). More... | |
void | renameUnitSIdRefs (string oldid, string newid) |
Renames all the UnitSIdRef attributes on this element. More... | |
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 | replaceTopLevelAnnotationElement (XMLNode annotation) |
Replaces the given top-level element within the 'annotation' subelement of this SBML object and with the annotation element supplied. More... | |
int | replaceTopLevelAnnotationElement (string annotation) |
Replaces the given top-level element within the 'annotation' subelement of this SBML object and with the annotation element supplied. More... | |
int | setAnnotation (XMLNode annotation) |
Sets the value of the 'annotation' subelement of this SBML object. More... | |
int | setAnnotation (string annotation) |
Sets the value of the 'annotation' subelement of this SBML object. More... | |
int | setExponent (int value) |
Sets the 'exponent' attribute value of this Unit. More... | |
int | setExponent (double value) |
Sets the 'exponent' attribute value of this Unit. More... | |
int | setId (string sid) |
Predicate returning true if this object has a ModelHistory object attached to it. More... | |
int | setKind (int kind) |
Sets the 'kind' attribute value of this Unit. More... | |
int | setMetaId (string metaid) |
Sets the value of the 'metaid' attribute of this object. More... | |
int | setModelHistory (ModelHistory history) |
Sets the ModelHistory of this object. More... | |
int | setMultiplier (double value) |
Sets the 'multipler' attribute value of this Unit. More... | |
int | setName (string name) |
Predicate returning true if this object has a ModelHistory object attached to it. More... | |
int | setNamespaces (XMLNamespaces xmlns) |
Sets the namespaces relevant of this SBML object. More... | |
int | setNotes (XMLNode notes) |
Sets the value of the 'notes' subelement of this SBML object. More... | |
int | setNotes (string notes, bool addXHTMLMarkup) |
Sets the value of the 'notes' subelement of this SBML object to a copy of the string notes . More... | |
int | setNotes (string notes) |
Sets the value of the 'notes' subelement of this SBML object to a copy of the string notes . More... | |
int | setOffset (double value) |
Sets the 'offset' attribute value of this Unit. More... | |
void | setSBMLNamespacesAndOwn (SBMLNamespaces sbmlns) |
Subclasses should override this method to write out their contained SBML objects as XML elements. More... | |
int | setSBOTerm (int value) |
Sets the value of the 'sboTerm' attribute. More... | |
int | setSBOTerm (string sboid) |
Sets the value of the 'sboTerm' attribute by string. More... | |
int | setScale (int value) |
Sets the 'scale' attribute value of this Unit. More... | |
string | toSBML () |
Returns a string consisting of a partial SBML corresponding to just this object. More... | |
Unit (long level, long version) | |
Creates a new Unit using the given SBML level and version values. More... | |
Unit (SBMLNamespaces sbmlns) | |
Creates a new Unit using the given SBMLNamespaces object sbmlns . More... | |
Unit (Unit orig) | |
Copy constructor; creates a copy of this Unit. More... | |
int | unsetAnnotation () |
Unsets the value of the 'annotation' subelement of this SBML object. More... | |
int | unsetCVTerms () |
Clears the list of CVTerm objects attached to this SBML object. More... | |
int | unsetId () |
Unsets the value of the 'id' attribute of this SBML object. More... | |
int | unsetMetaId () |
Unsets the value of the 'metaid' attribute of this SBML object. More... | |
int | unsetModelHistory () |
Unsets the ModelHistory object attached to this object. More... | |
int | unsetName () |
Unsets the value of the 'name' attribute of this SBML object. More... | |
int | unsetNotes () |
Unsets the value of the 'notes' subelement of this SBML object. More... | |
int | unsetSBOTerm () |
Unsets the value of the 'sboTerm' attribute of this SBML object. More... | |
void | writeExtensionElements (XMLOutputStream stream) |
Writes out contained SBML objects of package extensions (if any) as XML elements. More... | |
Static Public Member Functions | |
static bool | areEquivalent (Unit unit1, Unit unit2) |
Predicate returning true if Unit objects are equivalent. More... | |
static bool | areIdentical (Unit unit1, Unit unit2) |
Predicate returning true if two Unit objects are identical. More... | |
static UnitDefinition | convertToSI (Unit unit) |
Returns a UnitDefinition object containing the given unit converted to the appropriate SI unit. More... | |
static bool | isBuiltIn (string name, long level) |
Predicate to test whether a given string is the name of a predefined SBML unit. More... | |
static bool | isUnitKind (string name, long level, long version) |
Predicate to test whether a given string is the name of a valid base unit in SBML (such as 'gram' or 'mole' ). More... | |
static void | merge (Unit unit1, Unit unit2) |
Merges two Unit objects with the same 'kind' attribute value into a single Unit. More... | |
static bool | operator!= (SBase lhs, SBase rhs) |
static bool | operator== (SBase lhs, SBase rhs) |
static int | removeScale (Unit unit) |
Manipulates the attributes of the Unit to express the unit with the value of the scale attribute reduced to zero. More... | |
Protected Attributes | |
bool | swigCMemOwn |
libsbmlcs.Unit.Unit | ( | long | level, |
long | version | ||
) |
Creates a new Unit using the given SBML level
and version
values.
level | a long integer, the SBML Level to assign to this Unit |
version | a long integer, the SBML Version to assign to this Unit |
SBMLConstructorException | Thrown if the given level and version combination, or this kind of SBML object, are either invalid or mismatched with respect to the parent SBMLDocument object. |
libsbmlcs.Unit.Unit | ( | SBMLNamespaces | sbmlns | ) |
Creates a new Unit using the given SBMLNamespaces object sbmlns
.
The SBMLNamespaces object encapsulates SBML Level/Version/namespaces information. It is used to communicate the SBML Level, Version, and (in Level 3) packages used in addition to SBML Level 3 Core. A common approach to using this class constructor is to create an SBMLNamespaces object somewhere in a program, once, then pass it to object constructors such as this one when needed.
sbmlns | an SBMLNamespaces object. |
SBMLConstructorException | Thrown if the given level and version combination, or this kind of SBML object, are either invalid or mismatched with respect to the parent SBMLDocument object. |
libsbmlcs.Unit.Unit | ( | Unit | orig | ) |
Copy constructor; creates a copy of this Unit.
orig | the object to copy. |
SBMLConstructorException | Thrown if the argument orig is null . |
|
inherited |
Adds a copy of the given CVTerm object to this SBML object.
term | the CVTerm to assign. |
newBag | if true , creates a new RDF bag with the same identifier as a previous bag, and if false , adds the term to an existing RDF bag with the same type of qualifier as the term being added. |
|
inherited |
Adds a copy of the given CVTerm object to this SBML object.
term | the CVTerm to assign. |
newBag | if true , creates a new RDF bag with the same identifier as a previous bag, and if false , adds the term to an existing RDF bag with the same type of qualifier as the term being added. |
|
inherited |
Appends the given annotation
to the 'annotation' subelement of this object.
Whereas the SBase 'notes' subelement is a container for content to be shown directly to humans, the 'annotation' element is a container for optional software-generated content not meant to be shown to humans. Every object derived from SBase can have its own value for 'annotation'. The element's content type is XML type 'any', allowing essentially arbitrary well-formed XML data content.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
Unlike SBase::setAnnotation(XMLNode annotation) or SBase::setAnnotation(string annotation), this method allows other annotations to be preserved when an application adds its own data.
annotation | an XML structure that is to be copied and appended to the content of the 'annotation' subelement of this object |
|
inherited |
Appends the given annotation
to the 'annotation' subelement of this object.
Whereas the SBase 'notes' subelement is a container for content to be shown directly to humans, the 'annotation' element is a container for optional software-generated content not meant to be shown to humans. Every object derived from SBase can have its own value for 'annotation'. The element's content type is XML type 'any', allowing essentially arbitrary well-formed XML data content.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
Unlike SBase::setAnnotation(XMLNode annotation) or SBase::setAnnotation(string annotation), this method allows other annotations to be preserved when an application adds its own data.
annotation | an XML string that is to be copied and appended to the content of the 'annotation' subelement of this object |
|
inherited |
Appends the given notes
to the 'notes' subelement of this object.
The content of notes
is copied.
The optional SBML element named 'notes', present on every major SBML component type, is intended as a place for storing optional information intended to be seen by humans. An example use of the 'notes' element would be to contain formatted user comments about the model element in which the 'notes' element is enclosed. Every object derived directly or indirectly from type SBase can have a separate value for 'notes', allowing users considerable freedom when adding comments to their models.
The format of 'notes' elements must be XHTML 1.0. To help verify the formatting of 'notes' content, libSBML provides the static utility method SyntaxChecker::hasExpectedXHTMLSyntax(); however, readers are urged to consult the appropriate SBML specification document for the Level and Version of their model for more in-depth explanations. The SBML Level 2 and 3 specifications have considerable detail about how 'notes' element content must be structured.
notes | an XML node structure that is to appended to the content of the 'notes' subelement of this object |
|
inherited |
Appends the given notes
to the 'notes' subelement of this object.
The content of the parameter notes
is copied.
The optional SBML element named 'notes', present on every major SBML component type, is intended as a place for storing optional information intended to be seen by humans. An example use of the 'notes' element would be to contain formatted user comments about the model element in which the 'notes' element is enclosed. Every object derived directly or indirectly from type SBase can have a separate value for 'notes', allowing users considerable freedom when adding comments to their models.
The format of 'notes' elements must be XHTML 1.0. To help verify the formatting of 'notes' content, libSBML provides the static utility method SyntaxChecker::hasExpectedXHTMLSyntax(); however, readers are urged to consult the appropriate SBML specification document for the Level and Version of their model for more in-depth explanations. The SBML Level 2 and 3 specifications have considerable detail about how 'notes' element content must be structured.
notes | an XML string that is to appended to the content of the 'notes' subelement of this object |
Predicate returning true
if Unit objects are equivalent.
Two Unit objects are considered to be equivalent either if (1) both have a 'kind' attribute value of dimensionless
, or (2) their 'kind', 'exponent' and (for SBML Level 2 Version 1) 'offset' attribute values are equal. (Contrast this to the method areIdentical(), which compares Unit objects with respect to all attributes, not just the 'kind' and 'exponent'.)
true
if the 'kind' and 'exponent' attributes of unit1 are identical to the kind and exponent attributes of unit2, false
otherwise.Predicate returning true
if two Unit objects are identical.
Two Unit objects are considered to be identical if they match in all attributes. (Contrast this to the method areEquivalent(), which compares Unit objects only with respect to certain attributes.)
true
if all the attributes of unit1 are identical to the attributes of unit2, false
otherwise.
|
inherited |
Subclasses should override this method to write out their contained SBML objects as XML elements.
Be sure to call your parents implementation of this method as well. For example:
|
inherited |
Subclasses should override this method to write out their contained SBML objects as XML elements.
Be sure to call your parents implementation of this method as well. For example:
new Unit libsbmlcs.Unit.clone | ( | ) |
|
inherited |
Sets this SBML object to child SBML objects (if any).
(Creates a child-parent relationship by the parent)
Subclasses must override this function if they define one ore more child elements. Basically, this function needs to be called in constructor, copy constructor, assignment operator.
|
inherited |
Sets the parent SBML object of this SBML object.
(Creates a child-parent relationship by the child) This function is called when a child element is set/added/created by its parent element (e.g. by setXXX, addXXX, createXXX, and connectToChild functions of the parent element).
parent | the SBML object to use |
|
static |
Returns a UnitDefinition object containing the given unit
converted to the appropriate SI unit.
This method exists because some units can be expressed in terms of others when the same physical dimension is involved. For example, one hertz is identical to 1 sec-1, one litre is equivalent to 1 cubic decametre, and so on.
unit | the Unit object to convert to SI |
|
inherited |
Disables the given SBML Level 3 package.
This method enables or disables the specified package on this object and other objects connected by child-parent links in the same SBMLDocument object.
pkgURI | the URI of the package |
pkgPrefix | the XML prefix of the package |
|
virtual |
Reimplemented from libsbmlcs.SBase.
|
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).
|
inherited |
Enables or disables the given SBML Level 3 package.
This method enables or disables the specified package on this object and other objects connected by child-parent links in the same SBMLDocument object.
pkgURI | the URI of the package |
pkgPrefix | the XML prefix of the package |
flag | whether to enable (true ) or disable (false ) the package |
|
inherited |
Enables/Disables the given package with this element and child elements (if any).
(This is an internal implementation for enablePackage function)
|
inherited |
|
inherited |
Returns the first ancestor object that has the given SBML type code.
LibSBML attaches an identifying code to every kind of SBML object. These are known as SBML type codes. In the C# language interface for libSBML, the type codes are defined as static integer constants in the interface class libsbml. The names of the type codes all begin with the characters SBML_
.
This method searches the tree of objects that are parents of this object, and returns the first one that has the given SBML type code. If the optional argument pkgName
is given, it will cause the search to be limited to the SBML Level 3 package given.
type | the SBML type code of the object sought |
pkgName | (optional) the short name of an SBML Level 3 package to which the sought-after object must belong |
null
if no ancestor exists.
|
inherited |
Returns the first ancestor object that has the given SBML type code.
LibSBML attaches an identifying code to every kind of SBML object. These are known as SBML type codes. In the C# language interface for libSBML, the type codes are defined as static integer constants in the interface class libsbml. The names of the type codes all begin with the characters SBML_
.
This method searches the tree of objects that are parents of this object, and returns the first one that has the given SBML type code. If the optional argument pkgName
is given, it will cause the search to be limited to the SBML Level 3 package given.
type | the SBML type code of the object sought |
pkgName | (optional) the short name of an SBML Level 3 package to which the sought-after object must belong |
null
if no ancestor exists.
|
inherited |
Returns the content of the 'annotation' subelement of this object as a tree of XMLNode objects.
Whereas the SBML 'notes' subelement is a container for content to be shown directly to humans, the 'annotation' element is a container for optional software-generated content not meant to be shown to humans. Every object derived from SBase can have its own value for 'annotation'. The element's content type is XML type 'any', allowing essentially arbitrary well-formed XML data content.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
The annotations returned by this method will be in XML form. LibSBML provides an object model and related interfaces for certain specific kinds of annotations, namely model history information and RDF content. See the ModelHistory, CVTerm and RDFAnnotationParser classes for more information about the facilities available.
|
inherited |
Returns the content of the 'annotation' subelement of this object as a character string.
Whereas the SBML 'notes' subelement is a container for content to be shown directly to humans, the 'annotation' element is a container for optional software-generated content not meant to be shown to humans. Every object derived from SBase can have its own value for 'annotation'. The element's content type is XML type 'any', allowing essentially arbitrary well-formed XML data content.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
The annotations returned by this method will be in string form.
|
inherited |
Returns the column number on which this object first appears in the XML representation of the SBML document.
|
inherited |
|
inherited |
Returns a list of CVTerm objects in the annotations of this SBML object.
|
inherited |
Returns the first child element it can find with a specific 'metaid' attribute value, or null
if no such object is found.
metaid | string representing the 'metaid' attribute value of the object to find. |
|
inherited |
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' attribute value of the object to find. |
|
inherited |
Returns the first child element it can find with the given metaid
from all plug-ins associated with this element, or null
if no such object is found.
metaid | string representing the metaid of objects to find |
metaid
.
|
inherited |
Returns the first child element found that has the given id
in the model-wide SId namespace from all plug-ins associated with this element, or null
if no such object is found.
id | string representing the id of objects to find |
id
. new string libsbmlcs.Unit.getElementName | ( | ) |
Returns the XML element name of this object, which for Unit, is always 'unit'
.
'unit'
. int libsbmlcs.Unit.getExponent | ( | ) |
Returns the value of the 'exponent' attribute of this unit.
double libsbmlcs.Unit.getExponentAsDouble | ( | ) |
Returns the value of the 'exponent' attribute of this unit.
|
inherited |
|
inherited |
Returns the value of the 'metaid' attribute of this object.
The optional attribute named 'metaid', present on every major SBML component type, is for supporting metadata annotations using RDF (Resource Description Format). The attribute value has the data type XML ID, the XML identifier type, which means each 'metaid' value must be globally unique within an SBML file. (Importantly, this uniqueness criterion applies across any attribute with type XML ID, not just the 'metaid' attribute used by SBML—something to be aware of if your application-specific XML content inside the 'annotation' subelement happens to use XML ID.) The 'metaid' value serves to identify a model component for purposes such as referencing that component from metadata placed within 'annotation' subelements.
int libsbmlcs.Unit.getKind | ( | ) |
Returns the 'kind' of Unit this is.
|
inherited |
Returns the SBML Level of the SBMLDocument object containing this object.
|
inherited |
Returns the line number on which this object first appears in the XML representation of the SBML document.
|
inherited |
|
inherited |
|
inherited |
Returns the value of the 'metaid' attribute of this object.
The optional attribute named 'metaid', present on every major SBML component type, is for supporting metadata annotations using RDF (Resource Description Format). The attribute value has the data type XML ID, the XML identifier type, which means each 'metaid' value must be globally unique within an SBML file. (Importantly, this uniqueness criterion applies across any attribute with type XML ID, not just the 'metaid' attribute used by SBML—something to be aware of if your application-specific XML content inside the 'annotation' subelement happens to use XML ID.) The 'metaid' value serves to identify a model component for purposes such as referencing that component from metadata placed within 'annotation' subelements.
|
inherited |
|
inherited |
Returns the ModelHistory object, if any, attached to this object.
null
if none exist.double libsbmlcs.Unit.getMultiplier | ( | ) |
|
inherited |
Returns the value of the 'metaid' attribute of this object.
The optional attribute named 'metaid', present on every major SBML component type, is for supporting metadata annotations using RDF (Resource Description Format). The attribute value has the data type XML ID, the XML identifier type, which means each 'metaid' value must be globally unique within an SBML file. (Importantly, this uniqueness criterion applies across any attribute with type XML ID, not just the 'metaid' attribute used by SBML—something to be aware of if your application-specific XML content inside the 'annotation' subelement happens to use XML ID.) The 'metaid' value serves to identify a model component for purposes such as referencing that component from metadata placed within 'annotation' subelements.
|
inherited |
Returns a list of the XML Namespaces declared on this SBML document.
The SBMLNamespaces object encapsulates SBML Level/Version/namespaces information. It is used to communicate the SBML Level, Version, and (in SBML Level 3) packages used in addition to SBML Level 3 Core.
|
inherited |
Returns the content of the 'notes' subelement of this object as a tree of XMLNode objects.
The optional SBML element named 'notes', present on every major SBML component type, is intended as a place for storing optional information intended to be seen by humans. An example use of the 'notes' element would be to contain formatted user comments about the model element in which the 'notes' element is enclosed. Every object derived directly or indirectly from type SBase can have a separate value for 'notes', allowing users considerable freedom when adding comments to their models.
The format of 'notes' elements must be XHTML 1.0. To help verify the formatting of 'notes' content, libSBML provides the static utility method SyntaxChecker::hasExpectedXHTMLSyntax(); however, readers are urged to consult the appropriate SBML specification document for the Level and Version of their model for more in-depth explanations. The SBML Level 2 and 3 specifications have considerable detail about how 'notes' element content must be structured.
The 'notes' element content returned by this method will be in XML form, but libSBML does not provide an object model specifically for the content of notes. Callers will need to traverse the XML tree structure using the facilities available on XMLNode and related objects. For an alternative method of accessing the notes, see getNotesString().
|
inherited |
Returns the content of the 'notes' subelement of this object as a string.
The optional SBML element named 'notes', present on every major SBML component type, is intended as a place for storing optional information intended to be seen by humans. An example use of the 'notes' element would be to contain formatted user comments about the model element in which the 'notes' element is enclosed. Every object derived directly or indirectly from type SBase can have a separate value for 'notes', allowing users considerable freedom when adding comments to their models.
The format of 'notes' elements must be XHTML 1.0. To help verify the formatting of 'notes' content, libSBML provides the static utility method SyntaxChecker::hasExpectedXHTMLSyntax(); however, readers are urged to consult the appropriate SBML specification document for the Level and Version of their model for more in-depth explanations. The SBML Level 2 and 3 specifications have considerable detail about how 'notes' element content must be structured.
For an alternative method of accessing the notes, see getNotes(), which returns the content as an XMLNode tree structure. Depending on an application's needs, one or the other method may be more convenient.
|
inherited |
Returns the number of CVTerm objects in the annotations of this SBML object.
|
inherited |
Returns the number of plug-in objects (extenstion interfaces) for SBML Level 3 package extensions known.
double libsbmlcs.Unit.getOffset | ( | ) |
Returns the value of the 'offset' attribute of this Unit.
|
inherited |
Returns the name of the SBML Level 3 package in which this element is defined.
"core"
will be returned if this element is defined in SBML Level 3 Core. The string "unknown"
will be returned if this element is not defined in any SBML package.
|
inherited |
Returns the Version of the SBML Level 3 package to which this element belongs to.
0
will be returned if this element belongs to the SBML Level 3 Core package.
|
inherited |
Returns the parent SBML object containing this object.
This returns the immediately-containing object. This method is convenient when holding an object nested inside other objects in an SBML model.
|
inherited |
Returns a plug-in object (extension interface) for an SBML Level 3 package extension with the given package name or URI.
package | the name or URI of the package |
|
inherited |
Returns the nth plug-in object (extension interface) for an SBML Level 3 package extension.
n | the index of the plug-in to return |
|
inherited |
Returns the MIRIAM biological qualifier associated with the given resource.
In MIRIAM, qualifiers are an optional means of indicating the relationship between a model component and its annotations. There are two broad kinds of annotations: model and biological. The latter kind is used to qualify the relationship between a model component and a biological entity which it represents. Examples of relationships include 'is' and 'has part', but many others are possible. MIRIAM defines numerous relationship qualifiers to enable different software tools to qualify biological annotations in the same standardized way. In libSBML, the MIRIAM controlled-vocabulary annotations on an SBML model element are represented using lists of CVTerm objects, and the the MIRIAM biological qualifiers are represented using valueswhose names begin with BQB_
in the interface class libsbml.
This method searches the controlled-vocabulary annotations (i.e., the list of CVTerm objects) on the present object, then out of those that have biological qualifiers, looks for an annotation to the given resource
. If such an annotation is found, it returns the type of biological qualifier associated with that resource as a valuewhose names begin with BQB_
in the interface class libsbml.
resource | string representing the resource; e.g., 'http://www.geneontology.org/#GO:0005892' . |
BQB_
constants defined in libsbml may be expanded in later libSBML releases, to match the values defined by MIRIAM at that later time.
|
inherited |
Returns the MIRIAM model qualifier associated with the given resource.
In MIRIAM, qualifiers are an optional means of indicating the relationship between a model component and its annotations. There are two broad kinds of annotations: model and biological. The former kind is used to qualify the relationship between a model component and another modeling object. An example qualifier is 'isDerivedFrom', to indicate that a given component of the model is derived from the modeling object represented by the referenced resource. MIRIAM defines numerous relationship qualifiers to enable different software tools to qualify model annotations in the same standardized way. In libSBML, the MIRIAM controlled-vocabulary annotations on an SBML model element are represented using lists of CVTerm objects, and the the MIRIAM model qualifiers are represented using valueswhose names begin with BQB_
in the interface class libsbml.
This method method searches the controlled-vocabulary annotations (i.e., the list of CVTerm objects) on the present object, then out of those that have model qualifiers, looks for an annotation to the given resource
. If such an annotation is found, it returns the type of type of model qualifier associated with that resource as a valuewhose names begin with BQB_
in the interface class libsbml.
resource | string representing the resource; e.g., 'http://www.geneontology.org/#GO:0005892' . |
BQM_
constants defined in libsbml may be expanded in later libSBML releases, to match the values defined by MIRIAM at that later time.
|
inherited |
Returns the SBMLDocument object containing this object instance.
LibSBML uses the class SBMLDocument as a top-level container for storing SBML content and data associated with it (such as warnings and error messages). An SBML model in libSBML is contained inside an SBMLDocument object. SBMLDocument corresponds roughly to the class SBML defined in the SBML Level 3 and Level 2 specifications, but it does not have a direct correspondence in SBML Level 1. (But, it is created by libSBML no matter whether the model is Level 1, Level 2 or Level 3.)
This method allows the caller to obtain the SBMLDocument for the current object.
|
inherited |
Subclasses should override this method to write out their contained SBML objects as XML elements.
Be sure to call your parents implementation of this method as well. For example:
|
inherited |
Returns the integer portion of the value of the 'sboTerm' attribute of this object.
Beginning with SBML Level 2 Version 3, objects derived from SBase have an optional attribute named 'sboTerm' for supporting the use of the Systems Biology Ontology. In SBML proper, the data type of the attribute is a string of the form 'SBO:NNNNNNN', where 'NNNNNNN' is a seven digit integer number; libSBML simplifies the representation by only storing the 'NNNNNNN' integer portion. Thus, in libSBML, the 'sboTerm' attribute on SBase has data type int
, and SBO identifiers are stored simply as integers. (For convenience, libSBML offers methods for returning both the integer form and a text-string form of the SBO identifier.)
SBO terms are a type of optional annotation, and each different class of SBML object derived from SBase imposes its own requirements about the values permitted for 'sboTerm'. Please consult the SBML Level 2 Version 4 specification for more information about the use of SBO and the 'sboTerm' attribute.
-1
if the value is not set.
|
inherited |
Returns the identifiers.org URL representation of the 'sboTerm' attribute of this object.
This method returns the entire SBO identifier as a text string in the form 'http://identifiers.org/biomodels.sbo/SBO:NNNNNNN'.
SBO terms are a type of optional annotation, and each different class of SBML object derived from SBase imposes its own requirements about the values permitted for 'sboTerm'. Please consult the SBML Level 2 Version 4 specification for more information about the use of SBO and the 'sboTerm' attribute.
|
inherited |
Returns the string representation of the 'sboTerm' attribute of this object.
Beginning with SBML Level 2 Version 3, objects derived from SBase have an optional attribute named 'sboTerm' for supporting the use of the Systems Biology Ontology. In SBML proper, the data type of the attribute is a string of the form 'SBO:NNNNNNN', where 'NNNNNNN' is a seven digit integer number; libSBML simplifies the representation by only storing the 'NNNNNNN' integer portion. Thus, in libSBML, the 'sboTerm' attribute on SBase has data type int
, and SBO identifiers are stored simply as integers. This method returns the entire SBO identifier as a text string in the form 'SBO:NNNNNNN'.
SBO terms are a type of optional annotation, and each different class of SBML object derived from SBase imposes its own requirements about the values permitted for 'sboTerm'. Please consult the SBML Level 2 Version 4 specification for more information about the use of SBO and the 'sboTerm' attribute.
int libsbmlcs.Unit.getScale | ( | ) |
Returns the value of the 'scale' attribute of this unit.
new int libsbmlcs.Unit.getTypeCode | ( | ) |
Returns the libSBML type code of this object instance.
LibSBML attaches an identifying code to every kind of SBML object. These are known as SBML type codes. In the C# language interface for libSBML, the type codes are defined as static integer constants in the interface class libsbmlcs.libsbml. The names of the type codes all begin with the characters SBML_
.
|
inherited |
Returns the Version within the SBML Level of the SBMLDocument object containing this object.
|
inherited |
Check to see if the given prefix is used by any of the IDs defined by extension elements *excluding* 'id' and 'metaid' attributes (as, for example, the spatial id attributes 'spid').
new bool libsbmlcs.Unit.hasRequiredAttributes | ( | ) |
Predicate returning true
if all the required attributes for this Unit object have been set.
|
inherited |
Subclasses should override this method to write out their contained SBML objects as XML elements.
Be sure to call your parents implementation of this method as well. For example:
|
inherited |
Predicate returning true
if this object's level/version and namespace values correspond to a valid SBML specification.
The valid combinations of SBML Level, Version and Namespace as of this release of libSBML are the following:
'http://www.sbml.org/sbml/level1'
'http://www.sbml.org/sbml/level2'
'http://www.sbml.org/sbml/level2/version2'
'http://www.sbml.org/sbml/level2/version3'
'http://www.sbml.org/sbml/level2/version4'
'http://www.sbml.org/sbml/level3/version1/core'
true
if the level, version and namespace values of this SBML object correspond to a valid set of values, false
otherwise. void libsbmlcs.Unit.initDefaults | ( | ) |
Initializes the fields of this Unit object to 'typical' default values.
The SBML Unit component has slightly different aspects and default attribute values in different SBML Levels and Versions. This method sets the values to certain common defaults, based mostly on what they are in SBML Level 2. Specifically:
1
0
1.0
The 'kind' attribute is left unchanged.
bool libsbmlcs.Unit.isAmpere | ( | ) |
bool libsbmlcs.Unit.isAvogadro | ( | ) |
bool libsbmlcs.Unit.isBecquerel | ( | ) |
|
static |
Predicate to test whether a given string is the name of a predefined SBML unit.
name | a string to be tested against the predefined unit names |
level | the Level of SBML for which the determination should be made. This is necessary because there are a few small differences in allowed units between SBML Level 1 and Level 2. |
true
if name
is one of the five SBML predefined unit identifiers ('substance'
, 'volume'
, 'area'
, 'length'
or 'time'
), false
otherwise.'length'
and 'area'
were added in Level 2 Version 1.bool libsbmlcs.Unit.isCandela | ( | ) |
bool libsbmlcs.Unit.isCelsius | ( | ) |
Predicate for testing whether this Unit is of the kind Celsius
.
true
if the kind of this Unit is Celsius
, false
otherwise.Celsius
was removed from the list of predefined units in SBML Level 2 Version 2 at the same time that the 'offset' attribute was removed from Unit definitions. LibSBML methods such as this one related to Celsius
are retained in order to support SBML Level 2 Version 1, but their use is strongly discouraged. bool libsbmlcs.Unit.isCoulomb | ( | ) |
bool libsbmlcs.Unit.isDimensionless | ( | ) |
bool libsbmlcs.Unit.isFarad | ( | ) |
bool libsbmlcs.Unit.isGram | ( | ) |
bool libsbmlcs.Unit.isGray | ( | ) |
bool libsbmlcs.Unit.isHenry | ( | ) |
bool libsbmlcs.Unit.isHertz | ( | ) |
bool libsbmlcs.Unit.isItem | ( | ) |
bool libsbmlcs.Unit.isJoule | ( | ) |
bool libsbmlcs.Unit.isKatal | ( | ) |
bool libsbmlcs.Unit.isKelvin | ( | ) |
bool libsbmlcs.Unit.isKilogram | ( | ) |
bool libsbmlcs.Unit.isLitre | ( | ) |
bool libsbmlcs.Unit.isLumen | ( | ) |
bool libsbmlcs.Unit.isLux | ( | ) |
bool libsbmlcs.Unit.isMetre | ( | ) |
bool libsbmlcs.Unit.isMole | ( | ) |
bool libsbmlcs.Unit.isNewton | ( | ) |
bool libsbmlcs.Unit.isOhm | ( | ) |
|
inherited |
Predicate returning true
if the given SBML Level 3 package is enabled with this object.
The search ignores the package version.
pkgName | the name of the package |
true
if the given package is enabled within this object, false
otherwise.
|
inherited |
Predicate returning true
if an SBML Level 3 package with the given URI is enabled with this object.
pkgURI | the URI of the package |
true
if the given package is enabled within this object, false
otherwise.bool libsbmlcs.Unit.isPascal | ( | ) |
|
inherited |
Predicate returning true
if the given SBML Level 3 package is enabled with this object.
The search ignores the package version.
pkgName | the name of the package |
true
if the given package is enabled within this object, false
otherwise.
|
inherited |
Predicate returning true
if an SBML Level 3 package with the given URI is enabled with this object.
pkgURI | the URI of the package |
true
if the given package is enabled within this object, false
otherwise.bool libsbmlcs.Unit.isRadian | ( | ) |
bool libsbmlcs.Unit.isSecond | ( | ) |
|
inherited |
Predicate returning true
if this object's 'annotation' subelement exists and has content.
Whereas the SBase 'notes' subelement is a container for content to be shown directly to humans, the 'annotation' element is a container for optional software-generated content not meant to be shown to humans. Every object derived from SBase can have its own value for 'annotation'. The element's content type is XML type 'any', allowing essentially arbitrary well-formed XML data content.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
true
if a 'annotation' subelement exists, false
otherwise.bool libsbmlcs.Unit.isSetExponent | ( | ) |
|
inherited |
Predicate returning true
if this object's 'metaid' attribute is set.
The optional attribute named 'metaid', present on every major SBML component type, is for supporting metadata annotations using RDF (Resource Description Format). The attribute value has the data type XML ID, the XML identifier type, which means each 'metaid' value must be globally unique within an SBML file. (Importantly, this uniqueness criterion applies across any attribute with type XML ID, not just the 'metaid' attribute used by SBML—something to be aware of if your application-specific XML content inside the 'annotation' subelement happens to use XML ID.) The 'metaid' value serves to identify a model component for purposes such as referencing that component from metadata placed within 'annotation' subelements.
true
if the 'metaid' attribute of this SBML object is set, false
otherwise.bool libsbmlcs.Unit.isSetKind | ( | ) |
|
inherited |
Predicate returning true
if this object's 'metaid' attribute is set.
The optional attribute named 'metaid', present on every major SBML component type, is for supporting metadata annotations using RDF (Resource Description Format). The attribute value has the data type XML ID, the XML identifier type, which means each 'metaid' value must be globally unique within an SBML file. (Importantly, this uniqueness criterion applies across any attribute with type XML ID, not just the 'metaid' attribute used by SBML—something to be aware of if your application-specific XML content inside the 'annotation' subelement happens to use XML ID.) The 'metaid' value serves to identify a model component for purposes such as referencing that component from metadata placed within 'annotation' subelements.
true
if the 'metaid' attribute of this SBML object is set, false
otherwise.
|
inherited |
Predicate returning true
if this object has a ModelHistory object attached to it.
true
if the ModelHistory of this object is set, false
otherwise.bool libsbmlcs.Unit.isSetMultiplier | ( | ) |
|
inherited |
Predicate returning true
if this object's 'metaid' attribute is set.
The optional attribute named 'metaid', present on every major SBML component type, is for supporting metadata annotations using RDF (Resource Description Format). The attribute value has the data type XML ID, the XML identifier type, which means each 'metaid' value must be globally unique within an SBML file. (Importantly, this uniqueness criterion applies across any attribute with type XML ID, not just the 'metaid' attribute used by SBML—something to be aware of if your application-specific XML content inside the 'annotation' subelement happens to use XML ID.) The 'metaid' value serves to identify a model component for purposes such as referencing that component from metadata placed within 'annotation' subelements.
true
if the 'metaid' attribute of this SBML object is set, false
otherwise.
|
inherited |
Predicate returning true
if this object's 'notes' subelement exists and has content.
The optional SBML element named 'notes', present on every major SBML component type, is intended as a place for storing optional information intended to be seen by humans. An example use of the 'notes' element would be to contain formatted user comments about the model element in which the 'notes' element is enclosed. Every object derived directly or indirectly from type SBase can have a separate value for 'notes', allowing users considerable freedom when adding comments to their models.
The format of 'notes' elements must be XHTML 1.0. To help verify the formatting of 'notes' content, libSBML provides the static utility method SyntaxChecker::hasExpectedXHTMLSyntax(); however, readers are urged to consult the appropriate SBML specification document for the Level and Version of their model for more in-depth explanations. The SBML Level 2 and 3 specifications have considerable detail about how 'notes' element content must be structured.
true
if a 'notes' subelement exists, false
otherwise.
|
inherited |
Predicate returning true
if this object's 'sboTerm' attribute is set.
true
if the 'sboTerm' attribute of this SBML object is set, false
otherwise. bool libsbmlcs.Unit.isSetScale | ( | ) |
bool libsbmlcs.Unit.isSiemens | ( | ) |
bool libsbmlcs.Unit.isSievert | ( | ) |
bool libsbmlcs.Unit.isSteradian | ( | ) |
bool libsbmlcs.Unit.isTesla | ( | ) |
|
static |
Predicate to test whether a given string is the name of a valid base unit in SBML (such as 'gram'
or 'mole'
).
This method exists because prior to SBML Level 2 Version 3, an enumeration called UnitKind
was defined by SBML. This enumeration was removed in SBML Level 2 Version 3 and its values were folded into the space of values of a type called UnitSId
. This method therefore has less significance in SBML Level 2 Version 3 and Level 2 Version 4, but remains for backward compatibility and support for reading models in older Versions of Level 2.
name | a string to be tested |
level | a long integer representing the SBML specification Level |
version | a long integer representing the SBML specification Version |
true
if name is a valid SBML UnitKind, false
otherwisebool libsbmlcs.Unit.isVolt | ( | ) |
bool libsbmlcs.Unit.isWatt | ( | ) |
bool libsbmlcs.Unit.isWeber | ( | ) |
|
inherited |
Returns true
if this object's set of XML namespaces are a subset of the given object's XML namespaces.
sb | an object to compare with respect to namespaces |
true
if this object's collection of namespaces is a subset of sb's
, false
otherwise.
|
inherited |
Returns true
if this object's set of XML namespaces are the same as the given object's XML namespaces.
sb | an object to compare with respect to namespaces |
true
if this object's collection of namespaces is the same as sb's
, false
otherwise. Merges two Unit objects with the same 'kind' attribute value into a single Unit.
For example, the following, <unit kind="metre" exponent="2"> <unit kind="metre" exponent="1">
would be merged to become <unit kind="metre" exponent="3">
unit1 | the first Unit object; the result of the operation is left as a new version of this unit, modified in-place. |
unit2 | the second Unit object to merge with the first |
|
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.
|
inherited |
Removes itself from its parent.
If the parent was storing it as a pointer, it is deleted. If not, it is simply cleared (as in ListOf objects). Pure virutal, as every SBase element has different parents, and therefore different methods of removing itself. Will fail (and not delete itself) if it has no parent object. This function is designed to be overridden, but for all objects whose parent is of the class ListOf, the default implementation will work.
|
static |
Manipulates the attributes of the Unit to express the unit with the value of the scale attribute reduced to zero.
For example, 1 millimetre can be expressed as a Unit with kind='metre'
multiplier='1'
scale='-3'
exponent='1'
. It can also be expressed as a Unit with kind='metre'
multiplier='0.001'
scale='0'
exponent='1'
.
unit | the Unit object to manipulate. |
|
inherited |
Removes the top-level element within the 'annotation' subelement of this SBML object with the given name and optional URI.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
Calling this method allows a particular annotation element to be removed whilst the remaining annotations remain intact.
elementName | a string representing the name of the top level annotation element that is to be removed |
elementURI | an optional string that is used to check both the name and URI of the top level element to be removed |
|
inherited |
Removes the top-level element within the 'annotation' subelement of this SBML object with the given name and optional URI.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
Calling this method allows a particular annotation element to be removed whilst the remaining annotations remain intact.
elementName | a string representing the name of the top level annotation element that is to be removed |
elementURI | an optional string that is used to check both the name and URI of the top level element to be removed |
|
inherited |
Renames all the MetaIdRef
attributes on this element.
This method works by looking at all meta-attribute values, comparing the identifiers to the value of oldid
. If any matches are found, the matching identifiers are replaced with newid
. The method does not descend into child elements.
oldid | the old identifier |
newid | the new identifier |
|
inherited |
Renames all the SIdRef
attributes on this element, including any found in MathML content (if such exists).
This method works by looking at all attributes and (if appropriate) mathematical formulas, comparing the identifiers to the value of oldid
. If any matches are found, the matching identifiers are replaced with newid
. The method does not descend into child elements.
oldid | the old identifier |
newid | the new identifier |
|
inherited |
Renames all the UnitSIdRef
attributes on this element.
This method works by looking at all unit identifier attribute values (including, if appropriate, inside mathematical formulas), comparing the unit identifiers to the value of oldid
. If any matches are found, the matching identifiers are replaced with newid
. The method does not descend into child elements.
oldid | the old identifier |
newid | the new identifier |
|
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 |
Replaces the given top-level element within the 'annotation' subelement of this SBML object and with the annotation element supplied.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
This method determines the name of the element to be replaced from the annotation argument. Functionally it is equivalent to calling removeTopLevelAnnotationElement(name); appendAnnotation(annotation_with_name);
with the exception that the placement of the annotation element remains the same.
annotation | XMLNode representing the replacement top level annotation |
|
inherited |
Replaces the given top-level element within the 'annotation' subelement of this SBML object and with the annotation element supplied.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
This method determines the name of the element to be replaced from the annotation argument. Functionally it is equivalent to calling removeTopLevelAnnotationElement(name); appendAnnotation(annotation_with_name);
with the exception that the placement of the annotation element remains the same.
annotation | string representing the replacement top level annotation |
|
inherited |
Sets the value of the 'annotation' subelement of this SBML object.
The content of annotation
is copied, and any previous content of this object's 'annotation' subelement is deleted.
Whereas the SBase 'notes' subelement is a container for content to be shown directly to humans, the 'annotation' element is a container for optional software-generated content not meant to be shown to humans. Every object derived from SBase can have its own value for 'annotation'. The element's content type is XML type 'any', allowing essentially arbitrary well-formed XML data content.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
Call this method will result in any existing content of the 'annotation' subelement to be discarded. Unless you have taken steps to first copy and reconstitute any existing annotations into the annotation
that is about to be assigned, it is likely that performing such wholesale replacement is unfriendly towards other software applications whose annotations are discarded. An alternative may be to use SBase::appendAnnotation(XMLNode annotation) or SBase::appendAnnotation(string annotation).
annotation | an XML structure that is to be used as the new content of the 'annotation' subelement of this object |
|
inherited |
Sets the value of the 'annotation' subelement of this SBML object.
The content of annotation
is copied, and any previous content of this object's 'annotation' subelement is deleted.
Whereas the SBase 'notes' subelement is a container for content to be shown directly to humans, the 'annotation' element is a container for optional software-generated content not meant to be shown to humans. Every object derived from SBase can have its own value for 'annotation'. The element's content type is XML type 'any', allowing essentially arbitrary well-formed XML data content.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
Call this method will result in any existing content of the 'annotation' subelement to be discarded. Unless you have taken steps to first copy and reconstitute any existing annotations into the annotation
that is about to be assigned, it is likely that performing such wholesale replacement is unfriendly towards other software applications whose annotations are discarded. An alternative may be to use SBase::appendAnnotation(XMLNode annotation) or SBase::appendAnnotation(string annotation).
annotation | an XML string that is to be used as the content of the 'annotation' subelement of this object |
int libsbmlcs.Unit.setExponent | ( | int | value | ) |
Sets the 'exponent' attribute value of this Unit.
value | the integer to which the attribute 'exponent' should be set |
int libsbmlcs.Unit.setExponent | ( | double | value | ) |
Sets the 'exponent' attribute value of this Unit.
value | the double to which the attribute 'exponent' should be set |
|
inherited |
Predicate returning true
if this object has a ModelHistory object attached to it.
true
if the ModelHistory of this object is set, false
otherwise.int libsbmlcs.Unit.setKind | ( | int | kind | ) |
Sets the 'kind' attribute value of this Unit.
|
inherited |
Sets the value of the 'metaid' attribute of this object.
The string metaid
is copied. The value of metaid
must be an identifier conforming to the syntax defined by the XML 1.0 data type ID. Among other things, this type requires that a value is unique among all the values of type XML ID in an SBMLDocument. Although SBML only uses XML ID for the 'metaid' attribute, callers should be careful if they use XML ID's in XML portions of a model that are not defined by SBML, such as in the application-specific content of the 'annotation' subelement.
metaid | the identifier string to use as the value of the 'metaid' attribute |
|
inherited |
Sets the ModelHistory of this object.
The content of history
is copied, and this object's existing model history content is deleted.
history | ModelHistory of this object. |
int libsbmlcs.Unit.setMultiplier | ( | double | value | ) |
Sets the 'multipler' attribute value of this Unit.
value | the floating-point value to which the attribute 'multiplier' should be set |
|
inherited |
Predicate returning true
if this object has a ModelHistory object attached to it.
true
if the ModelHistory of this object is set, false
otherwise.
|
inherited |
Sets the namespaces relevant of this SBML object.
The content of xmlns
is copied, and this object's existing namespace content is deleted.
The SBMLNamespaces object encapsulates SBML Level/Version/namespaces information. It is used to communicate the SBML Level, Version, and (in Level 3) packages used in addition to SBML Level 3 Core.
xmlns | the namespaces to set |
|
inherited |
Sets the value of the 'notes' subelement of this SBML object.
The content of notes
is copied, and any existing content of this object's 'notes' subelement is deleted.
The optional SBML element named 'notes', present on every major SBML component type, is intended as a place for storing optional information intended to be seen by humans. An example use of the 'notes' element would be to contain formatted user comments about the model element in which the 'notes' element is enclosed. Every object derived directly or indirectly from type SBase can have a separate value for 'notes', allowing users considerable freedom when adding comments to their models.
The format of 'notes' elements must be XHTML 1.0. To help verify the formatting of 'notes' content, libSBML provides the static utility method SyntaxChecker::hasExpectedXHTMLSyntax(); however, readers are urged to consult the appropriate SBML specification document for the Level and Version of their model for more in-depth explanations. The SBML Level 2 and 3 specifications have considerable detail about how 'notes' element content must be structured.
notes | an XML structure that is to be used as the content of the 'notes' subelement of this object |
|
inherited |
Sets the value of the 'notes' subelement of this SBML object to a copy of the string notes
.
The content of notes
is copied, and any existing content of this object's 'notes' subelement is deleted.
The optional SBML element named 'notes', present on every major SBML component type, is intended as a place for storing optional information intended to be seen by humans. An example use of the 'notes' element would be to contain formatted user comments about the model element in which the 'notes' element is enclosed. Every object derived directly or indirectly from type SBase can have a separate value for 'notes', allowing users considerable freedom when adding comments to their models.
The format of 'notes' elements must be XHTML 1.0. To help verify the formatting of 'notes' content, libSBML provides the static utility method SyntaxChecker::hasExpectedXHTMLSyntax(); however, readers are urged to consult the appropriate SBML specification document for the Level and Version of their model for more in-depth explanations. The SBML Level 2 and 3 specifications have considerable detail about how 'notes' element content must be structured.
The following code illustrates a very simple way of setting the notes using this method. Here, the object being annotated is the whole SBML document, but that is for illustration purposes only; you could of course use this same approach to annotate any other SBML component. SBMLDocument s = new SBMLDocument(3, 1); s.setNotes('<body xmlns="http://www.w3.org/1999/xhtml">
here is my note
</body>');
notes | an XML string that is to be used as the content of the 'notes' subelement of this object |
addXHTMLMarkup | a bool indicating whether to wrap the contents of the notes argument with XHTML paragraph (<p> ) tags. This is appropriate when the string in notes does not already containg the appropriate XHTML markup. |
|
inherited |
Sets the value of the 'notes' subelement of this SBML object to a copy of the string notes
.
The content of notes
is copied, and any existing content of this object's 'notes' subelement is deleted.
The optional SBML element named 'notes', present on every major SBML component type, is intended as a place for storing optional information intended to be seen by humans. An example use of the 'notes' element would be to contain formatted user comments about the model element in which the 'notes' element is enclosed. Every object derived directly or indirectly from type SBase can have a separate value for 'notes', allowing users considerable freedom when adding comments to their models.
The format of 'notes' elements must be XHTML 1.0. To help verify the formatting of 'notes' content, libSBML provides the static utility method SyntaxChecker::hasExpectedXHTMLSyntax(); however, readers are urged to consult the appropriate SBML specification document for the Level and Version of their model for more in-depth explanations. The SBML Level 2 and 3 specifications have considerable detail about how 'notes' element content must be structured.
The following code illustrates a very simple way of setting the notes using this method. Here, the object being annotated is the whole SBML document, but that is for illustration purposes only; you could of course use this same approach to annotate any other SBML component. SBMLDocument s = new SBMLDocument(3, 1); s.setNotes('<body xmlns="http://www.w3.org/1999/xhtml">
here is my note
</body>');
notes | an XML string that is to be used as the content of the 'notes' subelement of this object |
addXHTMLMarkup | a bool indicating whether to wrap the contents of the notes argument with XHTML paragraph (<p> ) tags. This is appropriate when the string in notes does not already containg the appropriate XHTML markup. |
int libsbmlcs.Unit.setOffset | ( | double | value | ) |
Sets the 'offset' attribute value of this Unit.
value | the float-point value to which the attribute 'offset' should set |
|
inherited |
Subclasses should override this method to write out their contained SBML objects as XML elements.
Be sure to call your parents implementation of this method as well. For example:
|
inherited |
Sets the value of the 'sboTerm' attribute.
Beginning with SBML Level 2 Version 3, objects derived from SBase have an optional attribute named 'sboTerm' for supporting the use of the Systems Biology Ontology. In SBML proper, the data type of the attribute is a string of the form 'SBO:NNNNNNN', where 'NNNNNNN' is a seven digit integer number; libSBML simplifies the representation by only storing the 'NNNNNNN' integer portion. Thus, in libSBML, the 'sboTerm' attribute on SBase has data type int
, and SBO identifiers are stored simply as integers.
SBO terms are a type of optional annotation, and each different class of SBML object derived from SBase imposes its own requirements about the values permitted for 'sboTerm'. Please consult the SBML Level 2 Version 4 specification for more information about the use of SBO and the 'sboTerm' attribute.
value | the NNNNNNN integer portion of the SBO identifier |
|
inherited |
Sets the value of the 'sboTerm' attribute by string.
Beginning with SBML Level 2 Version 3, objects derived from SBase have an optional attribute named 'sboTerm' for supporting the use of the Systems Biology Ontology. In SBML proper, the data type of the attribute is a string of the form 'SBO:NNNNNNN', where 'NNNNNNN' is a seven digit integer number; libSBML simplifies the representation by only storing the 'NNNNNNN' integer portion. Thus, in libSBML, the 'sboTerm' attribute on SBase has data type int
, and SBO identifiers are stored simply as integers. This method lets you set the value of 'sboTerm' as a complete string of the form 'SBO:NNNNNNN', whereas setSBOTerm(int value) allows you to set it using the integer form.
SBO terms are a type of optional annotation, and each different class of SBML object derived from SBase imposes its own requirements about the values permitted for 'sboTerm'. Please consult the SBML Level 2 Version 4 specification for more information about the use of SBO and the 'sboTerm' attribute.
int libsbmlcs.Unit.setScale | ( | int | value | ) |
Sets the 'scale' attribute value of this Unit.
value | the integer to which the attribute 'scale' should be set |
|
inherited |
Returns a string consisting of a partial SBML corresponding to just this object.
|
inherited |
Unsets the value of the 'annotation' subelement of this SBML object.
Whereas the SBase 'notes' subelement is a container for content to be shown directly to humans, the 'annotation' element is a container for optional software-generated content not meant to be shown to humans. Every object derived from SBase can have its own value for 'annotation'. The element's content type is XML type 'any', allowing essentially arbitrary well-formed XML data content.
SBML places a few restrictions on the organization of the content of annotations; these are intended to help software tools read and write the data as well as help reduce conflicts between annotations added by different tools. Please see the SBML specifications for more details.
|
inherited |
Clears the list of CVTerm objects attached to this SBML object.
|
inherited |
Unsets the value of the 'id' attribute of this SBML object.
Most (but not all) objects in SBML include two common attributes: 'id' and 'name'. The identifier given by an object's 'id' attribute value is used to identify the object within the SBML model definition. Other objects can refer to the component using this identifier. The data type of 'id' is always either Sid
or UnitSId
, depending on the object in question. Both data types are defined as follows:
letter ::= 'a'..'z','A'..'Z' digit ::= '0'..'9' idChar ::= letter | digit | '_' SId ::= ( letter | '_' ) idChar*
The equality of SId
and UnitSId
type values in SBML is determined by an exact character sequence match; i.e., comparisons of these identifiers must be performed in a case-sensitive manner. This applies to all uses of SId
and UnitSId
.
|
inherited |
Unsets the value of the 'metaid' attribute of this SBML object.
The optional attribute named 'metaid', present on every major SBML component type, is for supporting metadata annotations using RDF (Resource Description Format). The attribute value has the data type XML ID, the XML identifier type, which means each 'metaid' value must be globally unique within an SBML file. (Importantly, this uniqueness criterion applies across any attribute with type XML ID, not just the 'metaid' attribute used by SBML—something to be aware of if your application-specific XML content inside the 'annotation' subelement happens to use XML ID.) The 'metaid' value serves to identify a model component for purposes such as referencing that component from metadata placed within 'annotation' subelements.
|
inherited |
Unsets the ModelHistory object attached to this object.
|
inherited |
Unsets the value of the 'name' attribute of this SBML object.
Most (but not all) objects in SBML include two common attributes: 'id' and 'name'. In contrast to the 'id' attribute, the 'name' attribute is optional and is not intended to be used for cross-referencing purposes within a model. Its purpose instead is to provide a human-readable label for the component. The data type of 'name' is the type string
defined in XML Schema. SBML imposes no restrictions as to the content of 'name' attributes beyond those restrictions defined by the string
type in XML Schema.
The recommended practice for handling 'name' is as follows. If a software tool has the capability for displaying the content of 'name' attributes, it should display this content to the user as a component's label instead of the component's 'id'. If the user interface does not have this capability (e.g., because it cannot display or use special characters in symbol names), or if the 'name' attribute is missing on a given component, then the user interface should display the value of the 'id' attribute instead. (Script language interpreters are especially likely to display 'id' instead of 'name'.)
As a consequence of the above, authors of systems that automatically generate the values of 'id' attributes should be aware some systems may display the 'id''s to the user. Authors therefore may wish to take some care to have their software create 'id' values that are: (a) reasonably easy for humans to type and read; and (b) likely to be meaningful, for example by making the 'id' attribute be an abbreviated form of the name attribute value.
An additional point worth mentioning is although there are restrictions on the uniqueness of 'id' values, there are no restrictions on the uniqueness of 'name' values in a model. This allows software applications leeway in assigning component identifiers.
|
inherited |
Unsets the value of the 'notes' subelement of this SBML object.
The optional SBML element named 'notes', present on every major SBML component type, is intended as a place for storing optional information intended to be seen by humans. An example use of the 'notes' element would be to contain formatted user comments about the model element in which the 'notes' element is enclosed. Every object derived directly or indirectly from type SBase can have a separate value for 'notes', allowing users considerable freedom when adding comments to their models.
The format of 'notes' elements must be XHTML 1.0. To help verify the formatting of 'notes' content, libSBML provides the static utility method SyntaxChecker::hasExpectedXHTMLSyntax(); however, readers are urged to consult the appropriate SBML specification document for the Level and Version of their model for more in-depth explanations. The SBML Level 2 and 3 specifications have considerable detail about how 'notes' element content must be structured.
|
inherited |
Unsets the value of the 'sboTerm' attribute of this SBML object.
|
inherited |
Writes out contained SBML objects of package extensions (if any) as XML elements.
|
protectedinherited |