Inheritance diagram for libsbml.Model:

Detailed Description

An SBML model.

In an SBML model definition, a single object of class Model serves as the overall container for the lists of the various model components. All of the lists are optional, but if a given list container is present within the model, the list must not be empty; that is, it must have length one or more. The following are the components and lists permitted in different Levels and Versions of SBML in version 5.18.0 of libSBML:

In SBML Level 1, the components are: UnitDefinition, Compartment, Species, Parameter, Rule, and Reaction. Instances of the classes are placed inside instances of classes ListOfUnitDefinitions, ListOfCompartments, ListOfSpecies, ListOfParameters, ListOfRules, and ListOfReactions.
In SBML Level 2 Version 1, the components are: FunctionDefinition, UnitDefinition, Compartment, Species, Parameter, Rule, Reaction and Event. Instances of the classes are placed inside instances of classes ListOfFunctionDefinitions, ListOfUnitDefinitions, ListOfCompartments, ListOfSpecies, ListOfParameters, ListOfRules, ListOfReactions, and ListOfEvents.
In SBML Level 2 Versions 2, 3 and 4, the components are: FunctionDefinition, UnitDefinition, CompartmentType, SpeciesType, Compartment, Species, Parameter, InitialAssignment, Rule, Constraint, Reaction and Event. Instances of the classes are placed inside instances of classes ListOfFunctionDefinitions, ListOfUnitDefinitions, ListOfCompartmentTypes, ListOfSpeciesTypes, ListOfCompartments, ListOfSpecies, ListOfParameters, ListOfInitialAssignments, ListOfRules, ListOfConstraints, ListOfReactions, and ListOfEvents.
In SBML Level 3 Version 1, the components are: FunctionDefinition, UnitDefinition, Compartment, Species, Parameter, InitialAssignment, Rule, Constraint, Reaction and Event. Instances of the classes are placed inside instances of classes ListOfFunctionDefinitions, ListOfUnitDefinitions, ListOfCompartments, ListOfSpecies, ListOfParameters, ListOfInitialAssignments, ListOfRules, ListOfConstraints, ListOfReactions, and ListOfEvents.

Although all the lists are optional, there are dependencies between SBML components such that defining some components requires defining others. An example is that defining a species requires defining a compartment, and defining a reaction requires defining a species. The dependencies are explained in more detail in the SBML specifications.

In addition to the above lists and attributes, the Model class in both SBML Level 2 and Level 3 has the usual two attributes of 'id' and 'name', and both are optional. As is the case for other SBML components with 'id' and 'name' attributes, they must be used according to the guidelines described in the SBML specifications. (Within the frameworks of SBML Level 2 and Level 3, a Model object identifier has no assigned meaning, but extension packages planned for SBML Level 3 are likely to make use of this identifier.)

Finally, SBML Level 3 has introduced a number of additional Model attributes. They are discussed in a separate section below.

Approaches to creating objects using the libSBML API

LibSBML provides two main mechanisms for creating objects: class constructors (e.g., Species.Species() ), and createObject() methods (such as Model.createSpecies()) provided by certain Object classes such as Model. These multiple mechanisms are provided by libSBML for flexibility and to support different use-cases, but they also have different implications for the overall model structure.

In general, the recommended approach is to use the createObject() methods. These methods both create an object and link it to the parent in one step. Here is an example:

 # Create an SBMLDocument object in Level 3 Version 1 format.
 # Make sure to check for possible failures.
 
 try:
   sbmlDoc = SBMLDocument(3, 1)
 except ValueError:
   print('Could not create SBMLDocument object')
   sys.exit(1)
 
 # Create a Model object inside the SBMLDocument object and set its
 # identifier, checking the returned values.  The call to setId() returns a
 # status code to indicate whether the assignment was successful.
 
 model = sbmlDoc.createModel()
 if model == None:
   # Do something to handle the error here.
   print('Unable to create Model object.')
   sys.exit(1)
 
 status = model.setId('BestModelEver')
 if status != LIBSBML_OPERATION_SUCCESS:
   # Do something to handle the error here.
   print('Unable to set identifier on the Model object')
   sys.exit(1)
 
 # Create a Species object inside the Model and set its identifier.
 # Again, the setId() returns a status code to indicate whether the
 # assignment was successful.
 
 sp = model.createSpecies()
 if sp == None:
   # Do something to handle the error here.
   print('Unable to create Species object.')
   sys.exit(1)
 
 status = sp.setId('BestSpeciesEver')
 if status != LIBSBML_OPERATION_SUCCESS:
   # Do something to handle the error here.
   print('Unable to set identifier on the Species object')
   sys.exit(1)

The createObject() methods return a pointer to the object created, but they also add the object to the relevant list of object instances contained in the parent. (These lists become the <listOfObjects> elements in the finished XML rendition of SBML.) In the example above, Model.createSpecies() adds the created species directly to the <listOfSpeciesgt; list in the model. Subsequently, methods called on the species change the species in the model (which is what is expected in most situations).

Consistency and adherence to SBML specifications

To make it easier for applications to do whatever they need, libSBML version 5.18.0 is relatively lax when it comes to enforcing correctness and completeness of models during model construction and editing. Essentially, libSBML will not in most cases check automatically that a model's components have valid attribute values, or that the overall model is consistent and free of errors—even obvious errors such as duplication of identifiers. This allows applications great leeway in how they build their models, but it means that software authors must take deliberate steps to ensure that the model will be, in the end, valid SBML. These steps include such things as keeping track of the identifiers used in a model, manually performing updates in certain situations where an entity is referenced in more than one place (e.g., a species that is referenced by multiple SpeciesReference objects), and so on.

That said, libSBML does provide powerful features for deliberately performing validation of SBML when an application decides it is time to do so. The interfaces to these facilities are on the SBMLDocument class, in the form of SBMLDocument.checkInternalConsistency() and SBMLDocument.checkConsistency(). Please refer to the documentation for SBMLDocument for more information about this.

While applications may play fast and loose and live like free spirits during the construction and editing of SBML models, they should always make sure to call SBMLDocument.checkInternalConsistency() and/or SBMLDocument.checkConsistency() before writing out the final version of an SBML model.

Model attributes introduced in SBML Level 3

As mentioned above, the Model class has a number of optional attributes in SBML Level 3. These are 'substanceUnits', 'timeUnits', 'volumeUnits', 'areaUnits', 'lengthUnits', 'extentUnits', and 'conversionFactor. The following provide more information about them.

The 'substanceUnits' attribute

The 'substanceUnits' attribute is used to specify the unit of measurement associated with substance quantities of Species objects that do not specify units explicitly. If a given Species object definition does not specify its unit of substance quantity via the 'substanceUnits' attribute on the Species object instance, then that species inherits the value of the Model 'substanceUnits' attribute. If the Model does not define a value for this attribute, then there is no unit to inherit, and all species that do not specify individual 'substanceUnits' attribute values then have no declared units for their quantities. The SBML Level 3 specifications provide more details.

Note that when the identifier of a species appears in a model's mathematical expressions, the unit of measurement associated with that identifier is not solely determined by setting 'substanceUnits' on Model or Species. Please see the discussion about units given in the documentation for the Species class.

The 'timeUnits' attribute

The 'timeUnits' attribute on SBML Level 3's Model object is used to specify the unit in which time is measured in the model. This attribute on Model is the only way to specify a unit for time in a model. It is a global attribute; time is measured in the model everywhere in the same way. This is particularly relevant to Reaction and RateRule objects in a model: all Reaction and RateRule objects in SBML define per-time values, and the unit of time is given by the 'timeUnits' attribute on the Model object instance. If the Model 'timeUnits' attribute has no value, it means that the unit of time is not defined for the model's reactions and rate rules. Leaving it unspecified in an SBML model does not result in an invalid model in SBML Level 3; however, as a matter of best practice, we strongly recommend that all models specify units of measurement for time.

The 'volumeUnits', 'areaUnits', and 'lengthUnits' attributes

The attributes 'volumeUnits', 'areaUnits' and 'lengthUnits' together are used to set the units of measurements for the sizes of Compartment objects in an SBML Level 3 model when those objects do not otherwise specify units. The three attributes correspond to the most common cases of compartment dimensions: 'volumeUnits' for compartments having a 'spatialDimensions' attribute value of '3', 'areaUnits' for compartments having a 'spatialDimensions' attribute value of '2', and 'lengthUnits' for compartments having a 'spatialDimensions' attribute value of '1'. The attributes are not applicable to compartments whose 'spatialDimensions' attribute values are not one of '1', '2' or '3'.

If a given Compartment object instance does not provide a value for its 'units' attribute, then the unit of measurement of that compartment's size is inherited from the value specified by the Model 'volumeUnits', 'areaUnits' or 'lengthUnits' attribute, as appropriate based on the Compartment object's 'spatialDimensions' attribute value. If the Model object does not define the relevant attribute, then there are no units to inherit, and all Compartment objects that do not set a value for their 'units' attribute then have no units associated with their compartment sizes.

The use of three separate attributes is a carry-over from SBML Level 2. Note that it is entirely possible for a model to define a value for two or more of the attributes 'volumeUnits', 'areaUnits' and 'lengthUnits' simultaneously, because SBML models may contain compartments with different numbers of dimensions.

The 'extentUnits' attribute

Reactions are processes that occur over time. These processes involve events of some sort, where a single ``reaction event'' is one in which some set of entities (known as reactants, products and modifiers in SBML) interact, once. The extent of a reaction is a measure of how many times the reaction has occurred, while the time derivative of the extent gives the instantaneous rate at which the reaction is occurring. Thus, what is colloquially referred to as the 'rate of the reaction' is in fact equal to the rate of change of reaction extent.

In SBML Level 3, the combination of 'extentUnits' and 'timeUnits' defines the units of kinetic laws in SBML and establishes how the numerical value of each KineticLaw object's mathematical formula is meant to be interpreted in a model. The units of the kinetic laws are taken to be 'extentUnits' divided by 'timeUnits'.

Note that this embodies an important principle in SBML Level 3 models: all reactions in an SBML model must have the same units for the rate of change of extent. In other words, the units of all reaction rates in the model must be the same. There is only one global value for 'extentUnits' and one global value for 'timeUnits'.

The 'conversionFactor' attribute

The attribute 'conversionFactor' in SBML Level 3's Model object defines a global value inherited by all Species object instances that do not define separate values for their 'conversionFactor' attributes. The value of this attribute must refer to a Parameter object instance defined in the model. The Parameter object in question must be a constant; ie it must have its 'constant' attribute value set to 'True'.

If a given Species object definition does not specify a conversion factor via the 'conversionFactor' attribute on Species, then the species inherits the conversion factor specified by the Model 'conversionFactor' attribute. If the Model does not define a value for this attribute, then there is no conversion factor to inherit. More information about conversion factors is provided in the SBML Level 3 specifications.

Public Member Functions
def	__init__ (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	addCompartment (self, c)
	Adds a copy of the given Compartment object to this Model. More...

def	addCompartmentType (self, ct)
	Adds a copy of the given CompartmentType object to this Model. More...

def	addConstraint (self, c)
	Adds a copy of the given Constraint object to this Model. More...

def	addCVTerm (self, term, newBag=False)
	Adds a copy of the given CVTerm object to this SBML object. More...

def	addEvent (self, e)
	Adds a copy of the given Event object to this Model. More...

def	addFunctionDefinition (self, fd)
	Adds a copy of the given FunctionDefinition object to this Model. More...

def	addInitialAssignment (self, ia)
	Adds a copy of the given InitialAssignment object to this Model. More...

def	addParameter (self, p)
	Adds a copy of the given Parameter object to this Model. More...

def	addReaction (self, r)
	Adds a copy of the given Reaction object to this Model. More...

def	addRule (self, r)
	Adds a copy of the given Rule object to this Model. More...

def	addSpecies (self, s)
	Adds a copy of the given Species object to this Model. More...

def	addSpeciesType (self, st)
	Adds a copy of the given SpeciesType object to this Model. More...

def	addUnitDefinition (self, ud)
	Adds a copy of the given UnitDefinition object to this Model. More...

def	appendAnnotation (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	appendFrom (self, model)
	Copies a given Model object's subcomponents and appends the copies to the appropriate places in this Model. More...

def	appendNotes (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	clearAllElementIdList (self)
	Clears the internal list of the identifiers of all elements within this Model object. More...

def	clearAllElementMetaIdList (self)
	Clears the internal list of the metaids of all elements within this Model object. More...

def	clone (self)
	Creates and returns a deep copy of this Model object. More...

def	connectToChild (self)

def	createAlgebraicRule (self)
	Creates a new AlgebraicRule inside this Model and returns it. More...

def	createAssignmentRule (self)
	Creates a new AssignmentRule inside this Model and returns it. More...

def	createCompartment (self)
	Creates a new Compartment inside this Model and returns it. More...

def	createCompartmentType (self)
	Creates a new CompartmentType inside this Model and returns it. More...

def	createConstraint (self)
	Creates a new Constraint inside this Model and returns it. More...

def	createDelay (self)
	Creates a new Delay inside the last Event object created in this Model, and returns a pointer to it. More...

def	createEvent (self)
	Creates a new Event inside this Model and returns it. More...

def	createEventAssignment (self)
	Creates a new EventAssignment inside the last Event object created in this Model, and returns a pointer to it. More...

def	createFunctionDefinition (self)
	Creates a new FunctionDefinition inside this Model and returns it. More...

def	createInitialAssignment (self)
	Creates a new InitialAssignment inside this Model and returns it. More...

def	createKineticLaw (self)
	Creates a new KineticLaw inside the last Reaction object created in this Model, and returns a pointer to it. More...

def	createKineticLawLocalParameter (self)
	Creates a new LocalParameter inside the KineticLaw object of the last Reaction created inside this Model, and returns a pointer to it. More...

def	createKineticLawParameter (self)
	Creates a new local Parameter inside the KineticLaw object of the last Reaction created inside this Model, and returns a pointer to it. More...

def	createModifier (self)
	Creates a new ModifierSpeciesReference object for a modifier species inside the last Reaction object in this Model, and returns a pointer to it. More...

def	createParameter (self)
	Creates a new Parameter inside this Model and returns it. More...

def	createProduct (self)
	Creates a new SpeciesReference object for a product inside the last Reaction object in this Model, and returns a pointer to it. More...

def	createRateRule (self)
	Creates a new RateRule inside this Model and returns it. More...

def	createReactant (self)
	Creates a new SpeciesReference object for a reactant inside the last Reaction object in this Model, and returns a pointer to it. More...

def	createReaction (self)
	Creates a new Reaction inside this Model and returns it. More...

def	createSpecies (self)
	Creates a new Species inside this Model and returns it. More...

def	createSpeciesType (self)
	Creates a new SpeciesType inside this Model and returns it. More...

def	createTrigger (self)
	Creates a new Trigger inside the last Event object created in this Model, and returns a pointer to it. More...

def	createUnit (self)
	Creates a new Unit object within the last UnitDefinition object created in this model and returns a pointer to it. More...

def	createUnitDefinition (self)
	Creates a new UnitDefinition inside this Model and returns it. More...

def	deleteDisabledPlugins (self, recursive=True)
	Deletes all information stored in disabled plugins. More...

def	disablePackage (self, pkgURI, pkgPrefix)
	Disables the given SBML Level 3 package on this object. More...

def	enablePackage (self, pkgURI, pkgPrefix, flag)
	Enables or disables the given SBML Level 3 package on this object. More...

def	getAllElementIdList (self)
	Returns the internal list of the identifiers of all elements within this Model object. More...

def	getAllElementMetaIdList (self)
	Returns the internal list of the metaids of all elements within this Model object. More...

def	getAncestorOfType (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	getAnnotation (self, args)
	Returns the content of the 'annotation' subelement of this object as a tree of XMLNode objects. More...

def	getAnnotationString (self, args)
	Returns the content of the 'annotation' subelement of this object as a character string. More...

def	getAreaUnits (self)
	Returns the value of the 'areaUnits' attribute of this Model. More...

def	getAssignmentRule (self, args)
	Get a Rule object based on the variable to which it assigns a value. More...

def	getAssignmentRuleByVariable (self, args)
	Get a Rule object based on the variable to which it assigns a value. More...

def	getColumn (self)
	Returns the column number where this object first appears in the XML representation of the SBML document. More...

def	getCompartment (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	getCompartmentType (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	getConstraint (self, args)
	Get the nth Constraint object in this Model. More...

def	getConversionFactor (self)
	Returns the value of the 'conversionFactor' attribute of this Model. More...

def	getCVTerm (self, n)
	Returns the nth CVTerm in the list of CVTerms of this SBML object. More...

def	getCVTerms (self, args)
	Returns a list of CVTerm objects in the annotations of this SBML object. More...

def	getDisabledPlugin (self, args)
	Returns the nth disabled plug-in object (extension interface) for an SBML Level 3 package extension. More...

def	getElementByMetaId (self, metaid)
	Returns the first child element it can find with the given `metaid`. More...

def	getElementBySId (self, id)
	Returns the first child element found that has the given `id`. More...

def	getElementName (self)
	Returns the XML element name of this object, which for Model, is always `'model'`. More...

def	getEvent (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	getExtentUnits (self)
	Returns the value of the 'extentUnits' attribute of this Model. More...

def	getFunctionDefinition (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	getId (self)
	Returns the value of the 'id' attribute of this Model. More...

def	getIdAttribute (self)
	Returns the value of the 'id' attribute of this SBML object. More...

def	getInitialAssignment (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	getInitialAssignmentBySymbol (self, args)
	Get an InitialAssignment object based on the symbol to which it assigns a value. More...

def	getLengthUnits (self)
	Returns the value of the 'lengthUnits' attribute of this Model. More...

def	getLevel (self)
	Returns the SBML Level of the SBMLDocument object containing this object. More...

def	getLine (self)
	Returns the line number where this object first appears in the XML representation of the SBML document. More...

def	getListOfAllElements (self, filter=None)
	Returns an SBaseList of all child SBase objects, including those nested to an arbitrary depth. More...

def	getListOfAllElementsFromPlugins (self, filter=None)
	Returns a List of all child SBase objects contained in SBML package plug-ins. More...

def	getListOfCompartments (self, args)
	Get the ListOfCompartments object in this Model. More...

def	getListOfCompartmentTypes (self, args)
	Get the ListOfCompartmentTypes object in this Model. More...

def	getListOfConstraints (self, args)
	Get the ListOfConstraints object in this Model. More...

def	getListOfEvents (self, args)
	Get the ListOfEvents object in this Model. More...

def	getListOfFunctionDefinitions (self, args)
	Get the ListOfFunctionDefinitions object in this Model. More...

def	getListOfInitialAssignments (self, args)
	Get the ListOfInitialAssignments object in this Model. More...

def	getListOfParameters (self, args)
	Get the ListOfParameters object in this Model. More...

def	getListOfReactions (self, args)
	Get the ListOfReactions object in this Model. More...

def	getListOfRules (self, args)
	Get the ListOfRules object in this Model. More...

def	getListOfSpecies (self, args)
	Get the ListOfSpecies object in this Model. More...

def	getListOfSpeciesTypes (self, args)
	Get the ListOfSpeciesTypes object in this Model. More...

def	getListOfUnitDefinitions (self, args)
	Get the ListOfUnitDefinitions object in this Model. More...

def	getMetaId (self)
	Returns the value of the 'metaid' attribute of this SBML object. More...

def	getModel (self)
	Returns the Model object for the SBML Document in which the current object is located. More...

def	getModelHistory (self, args)
	Returns the ModelHistory object, if any, attached to this object. More...

def	getModifierSpeciesReference (self, args)
	Get a ModifierSpeciesReference object based on its identifier. More...

def	getName (self)
	Returns the value of the 'name' attribute of this Model object. More...

def	getNamespaces (self)
	Returns a list of the XML Namespaces declared on the SBML document owning this object. More...

def	getNotes (self, args)
	Returns the content of the 'notes' subelement of this object as a tree of XMLNode objects. More...

def	getNotesString (self, args)
	Returns the content of the 'notes' subelement of this object as a string. More...

def	getNumCompartments (self)
	Get the number of Compartment objects in this Model. More...

def	getNumCompartmentTypes (self)
	Get the number of CompartmentType objects in this Model. More...

def	getNumConstraints (self)
	Get the number of Constraint objects in this Model. More...

def	getNumCVTerms (self)
	Returns the number of CVTerm objects in the annotations of this SBML object. More...

def	getNumDisabledPlugins (self)
	Returns the number of disabled plug-in objects (extension interfaces) for SBML Level 3 package extensions known. More...

def	getNumEvents (self)
	Get the number of Event objects in this Model. More...

def	getNumFunctionDefinitions (self)
	Get the number of FunctionDefinition objects in this Model. More...

def	getNumInitialAssignments (self)
	Get the number of InitialAssignment objects in this Model. More...

def	getNumParameters (self)
	Get the number of Parameter objects in this Model. More...

def	getNumPlugins (self)
	Returns the number of plug-in objects (extenstion interfaces) for SBML Level 3 package extensions known. More...

def	getNumReactions (self)
	Get the number of Reaction objects in this Model. More...

def	getNumRules (self)
	Get the number of Rule objects in this Model. More...

def	getNumSpecies (self)
	Get the number of Species objects in this Model. More...

def	getNumSpeciesTypes (self)
	Get the number of SpeciesType objects in this Model. More...

def	getNumSpeciesWithBoundaryCondition (self)
	Get the number of Species in this Model having their 'boundaryCondition' attribute value set to `True`. More...

def	getNumUnitDefinitions (self)
	Get the number of UnitDefinition objects in this Model. More...

def	getPackageCoreVersion (self)
	Returns the SBML Core Version within the SBML Level of the actual object. More...

def	getPackageName (self)
	Returns the name of the SBML Level 3 package in which this element is defined. More...

def	getPackageVersion (self)
	Returns the Version of the SBML Level 3 package to which this element belongs to. More...

def	getParameter (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	getParentSBMLObject (self, args)
	Returns the parent SBML object containing this object. More...

def	getPlugin (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	getPrefix (self)
	Returns the XML namespace prefix of this element. More...

def	getRateRule (self, args)
	Get a Rule object based on the variable to which it assigns a value. More...

def	getRateRuleByVariable (self, args)
	Get a Rule object based on the variable to which it assigns a value. More...

def	getReaction (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	getResourceBiologicalQualifier (self, resource)
	Returns the MIRIAM biological qualifier associated with the given resource. More...

def	getResourceModelQualifier (self, resource)
	Returns the MIRIAM model qualifier associated with the given resource. More...

def	getRule (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	getRuleByVariable (self, args)
	Get a Rule object based on the variable to which it assigns a value. More...

def	getSBMLDocument (self, args)
	Returns the SBMLDocument object containing this object instance. More...

def	getSBOTerm (self)
	Returns the integer portion of the value of the 'sboTerm' attribute of this object. More...

def	getSBOTermAsURL (self)
	Returns the URL representation of the 'sboTerm' attribute of this object. More...

def	getSBOTermID (self)
	Returns the string representation of the 'sboTerm' attribute of this object. More...

def	getSpecies (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	getSpeciesReference (self, args)
	Get a SpeciesReference object based on its identifier. More...

def	getSpeciesType (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	getSubstanceUnits (self)
	Returns the value of the 'substanceUnits' attribute of this Model. More...

def	getTimeUnits (self)
	Returns the value of the 'timeUnits' attribute of this Model. More...

def	getTypeCode (self)
	Returns the libSBML type code for this SBML object. More...

def	getUnitDefinition (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	getURI (self)
	Gets the namespace URI to which this element belongs to. More...

def	getVersion (self)
	Returns the Version within the SBML Level of the SBMLDocument object containing this object. More...

def	getVolumeUnits (self)
	Returns the value of the 'volumeUnits' attribute of this Model. More...

def	hasRequiredElements (self)
	Predicate returning `True` if all the required elements for this Model object have been set. More...

def	hasValidLevelVersionNamespaceCombination (self)
	Predicate returning `true` if this object's level/version and namespace values correspond to a valid SBML specification. More...

def	isPackageEnabled (self, pkgName)
	Predicate returning `True` if the given SBML Level 3 package is enabled with this object. More...

def	isPackageURIEnabled (self, pkgURI)
	Predicate returning `True` if an SBML Level 3 package with the given URI is enabled with this object. More...

def	isPkgEnabled (self, pkgName)
	Predicate returning `True` if the given SBML Level 3 package is enabled with this object. More...

def	isPkgURIEnabled (self, pkgURI)
	Predicate returning `True` if an SBML Level 3 package with the given URI is enabled with this object. More...

def	isPopulatedAllElementIdList (self)
	Predicate returning `True` if libSBML has a list of the ids of all components of this model. More...

def	isPopulatedAllElementMetaIdList (self)
	Predicate returning `True` if libSBML has a list of the metaids of all components of this model. More...

def	isPopulatedListFormulaUnitsData (self)
	Predicate returning `True` if libSBML has derived units for the components of this model. More...

def	isSetAnnotation (self)
	Predicate returning `True` if this object's 'annotation' subelement exists and has content. More...

def	isSetAreaUnits (self)
	Predicate returning `True` if this Model's 'areaUnits' attribute is set. More...

def	isSetConversionFactor (self)
	Predicate returning `True` if this Model's 'conversionFactor' attribute is set. More...

def	isSetExtentUnits (self)
	Predicate returning `True` if this Model's 'extentUnits' attribute is set. More...

def	isSetId (self)
	Predicate returning `True` if this Model's 'id' attribute is set. More...

def	isSetIdAttribute (self)
	Predicate returning `True` if this object's 'id' attribute is set. More...

def	isSetLengthUnits (self)
	Predicate returning `True` if this Model's 'lengthUnits' attribute is set. More...

def	isSetMetaId (self)
	Predicate returning `True` if this object's 'metaid' attribute is set. More...

def	isSetModelHistory (self)
	Predicate returning `True` if this object has a ModelHistory object attached to it. More...

def	isSetName (self)
	Predicate returning `True` if this Model's 'name' attribute is set. More...

def	isSetNotes (self)
	Predicate returning `True` if this object's 'notes' subelement exists and has content. More...

def	isSetSBOTerm (self)
	Predicate returning `True` if this object's 'sboTerm' attribute is set. More...

def	isSetSubstanceUnits (self)
	Predicate returning `True` if this Model's 'substanceUnits' attribute is set. More...

def	isSetTimeUnits (self)
	Predicate returning `True` if this Model's 'timeUnits' attribute is set. More...

def	isSetUserData (self)
	Predicate returning true or false depending on whether the user data of this element has been set. More...

def	isSetVolumeUnits (self)
	Predicate returning `True` if this Model's 'volumeUnits' attribute is set. More...

def	matchesRequiredSBMLNamespacesForAddition (self, args)
	Returns `True` if this object's set of XML namespaces are a subset of the given object's XML namespaces. More...

def	matchesSBMLNamespaces (self, args)
	Returns `True` if this object's set of XML namespaces are the same as the given object's XML namespaces. More...

def	populateAllElementIdList (self)
	Populates the internal list of the identifiers of all elements within this Model object. More...

def	populateAllElementMetaIdList (self)
	Populates the internal list of the metaids of all elements within this Model object. More...

def	populateListFormulaUnitsData (self)
	Populates the internal list of derived units for this Model object. More...

def	removeCompartment (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	removeCompartmentType (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	removeConstraint (self, n)
	Removes the nth Constraint object from this Model object and returns a pointer to it. More...

def	removeEvent (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	removeFromParentAndDelete (self)
	Remove this Model from its parent SBMLDocument object. More...

def	removeFunctionDefinition (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	removeInitialAssignment (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	removeParameter (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	removeReaction (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	removeRule (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	removeRuleByVariable (self, variable)
	Removes the Rule object with the given 'variable' attribute from this Model object and returns a pointer to it. More...

def	removeSpecies (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	removeSpeciesType (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	removeTopLevelAnnotationElement (self, args)
	Removes the top-level element within the 'annotation' subelement of this SBML object with the given name and optional URI. More...

def	removeUnitDefinition (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	renameMetaIdRefs (self, oldid, newid)
	Replaces all uses of a given meta identifier attribute value with another value. More...

def	renameSIdRefs (self, oldid, newid)
	Replaces all uses of a given `SIdRef` type attribute value with another value. More...

def	renameUnitSIdRefs (self, oldid, newid)
	Replaces all uses of a given `UnitSIdRef` type attribute value with another value. More...

def	replaceTopLevelAnnotationElement (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	setAnnotation (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	setAreaUnits (self, units)
	Sets the value of the 'areaUnits' attribute of this Model. More...

def	setConversionFactor (self, units)
	Sets the value of the 'conversionFactor' attribute of this Model. More...

def	setExtentUnits (self, units)
	Sets the value of the 'extentUnits' attribute of this Model. More...

def	setId (self, sid)
	Sets the value of the 'id' attribute of this Model. More...

def	setIdAttribute (self, sid)
	Sets the value of the 'id' attribute of this SBML object. More...

def	setLengthUnits (self, units)
	Sets the value of the 'lengthUnits' attribute of this Model. More...

def	setMetaId (self, metaid)
	Sets the value of the meta-identifier attribute of this SBML object. More...

def	setModelHistory (self, history)
	Sets the ModelHistory of this object. More...

def	setName (self, name)
	Sets the value of the 'name' attribute of this Model. More...

def	setNamespaces (self, xmlns)
	Sets the namespaces relevant of this SBML object. More...

def	setNotes (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	setSBOTerm (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	setSubstanceUnits (self, units)
	Sets the value of the 'substanceUnits' attribute of this Model. More...

def	setTimeUnits (self, units)
	Sets the value of the 'timeUnits' attribute of this Model. More...

def	setVolumeUnits (self, units)
	Sets the value of the 'volumeUnits' attribute of this Model. More...

def	toSBML (self)
	Returns a string consisting of a partial SBML corresponding to just this object. More...

def	toXMLNode (self)
	Returns this element as an XMLNode. More...

def	unsetAnnotation (self)
	Unsets the value of the 'annotation' subelement of this SBML object. More...

def	unsetAreaUnits (self)
	Unsets the value of the 'areaUnits' attribute of this Model. More...

def	unsetConversionFactor (self)
	Unsets the value of the 'conversionFactor' attribute of this Model. More...

def	unsetCVTerms (self)
	Clears the list of CVTerm objects attached to this SBML object. More...

def	unsetExtentUnits (self)
	Unsets the value of the 'extentUnits' attribute of this Model. More...

def	unsetId (self)
	Unsets the value of the 'id' attribute of this Model. More...

def	unsetIdAttribute (self)
	Unsets the value of the 'id' attribute of this SBML object. More...

def	unsetLengthUnits (self)
	Unsets the value of the 'lengthUnits' attribute of this Model. More...

def	unsetMetaId (self)
	Unsets the value of the 'metaid' attribute of this SBML object. More...

def	unsetModelHistory (self)
	Unsets the ModelHistory object attached to this object. More...

def	unsetName (self)
	Unsets the value of the 'name' attribute of this Model. More...

def	unsetNotes (self)
	Unsets the value of the 'notes' subelement of this SBML object. More...

def	unsetSBOTerm (self)
	Unsets the value of the 'sboTerm' attribute of this SBML object. More...

def	unsetSubstanceUnits (self)
	Unsets the value of the 'substanceUnits' attribute of this Model. More...

def	unsetTimeUnits (self)
	Unsets the value of the 'timeUnits' attribute of this Model. More...

def	unsetUserData (self)
	Unsets the user data of this element. More...

def	unsetVolumeUnits (self)
	Unsets the value of the 'volumeUnits' attribute of this Model. More...

Constructor & Destructor Documentation

def libsbml.Model.__init__	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

__init__(long  level, long  version)   Model
__init__(SBMLNamespaces sbmlns)   Model
__init__(Model orig)   Model

Each variant is described separately below.

Method variant with the following signature:

Model(SBMLNamespaces sbmlns)

Creates a new Model 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 libSBML's SBMLNamespaces facilities is to create an SBMLNamespaces object somewhere in a program once, then hand that object as needed to object constructors that accept SBMLNamespaces as arguments.

Parameters

sbmlns an SBMLNamespaces object.

Exceptions

ValueError Thrown if the given sbmlns is inconsistent or incompatible with this object.

Note: Attempting to add an object to an SBMLDocument having a different combination of SBML Level, Version and XML namespaces than the object itself will result in an error at the time a caller attempts to make the addition. A parent object must have compatible Level, Version and XML namespaces. (Strictly speaking, a parent may also have more XML namespaces than a child, but the reverse is not permitted.) The restriction is necessary to ensure that an SBML model has a consistent overall structure. This requires callers to manage their objects carefully, but the benefit is increased flexibility in how models can be created by permitting callers to create objects bottom-up if desired. In situations where objects are not yet attached to parents (e.g., SBMLDocument), knowledge of the intented SBML Level and Version help libSBML determine such things as whether it is valid to assign a particular value to an attribute.

Method variant with the following signature:

Model(long level, long version)

Creates a new Model using the given SBML level and version values.

Parameters

level	a long integer, the SBML Level to assign to this Model.
version	a long integer, the SBML Version to assign to this Model.

Exceptions

ValueError Thrown if the given level and version combination are invalid or if this object is incompatible with the given level and version.

Note: Attempting to add an object to an SBMLDocument having a different combination of SBML Level, Version and XML namespaces than the object itself will result in an error at the time a caller attempts to make the addition. A parent object must have compatible Level, Version and XML namespaces. (Strictly speaking, a parent may also have more XML namespaces than a child, but the reverse is not permitted.) The restriction is necessary to ensure that an SBML model has a consistent overall structure. This requires callers to manage their objects carefully, but the benefit is increased flexibility in how models can be created by permitting callers to create objects bottom-up if desired. In situations where objects are not yet attached to parents (e.g., SBMLDocument), knowledge of the intented SBML Level and Version help libSBML determine such things as whether it is valid to assign a particular value to an attribute.

Method variant with the following signature:

Model(Model orig)

Copy constructor; creates a (deep) copy of the given Model object.

Parameters

orig	the object to copy.

Member Function Documentation

def libsbml.Model.addCompartment	(	self,
		c
	)

Adds a copy of the given Compartment object to this Model.

addCompartment(Compartment c)   int

Parameters

c	the Compartment object to add.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: This method should be used with some caution. The fact that this method copies the object passed to it means that the caller will be left holding a physically different object instance than the one contained inside this object. Changes made to the original object instance (such as resetting attribute values) will not affect the instance in this object. In addition, the caller should make sure to free the original object if it is no longer being used, or else a memory leak will result. Please see other methods on this class (particularly a corresponding method whose name begins with the word create) for alternatives that do not lead to these issues.

See also: createCompartment()

def libsbml.Model.addCompartmentType	(	self,
		ct
	)

Adds a copy of the given CompartmentType object to this Model.

addCompartmentType(CompartmentType ct)   int

Parameters

ct	the CompartmentType object to add.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: This method should be used with some caution. The fact that this method copies the object passed to it means that the caller will be left holding a physically different object instance than the one contained inside this object. Changes made to the original object instance (such as resetting attribute values) will not affect the instance in this object. In addition, the caller should make sure to free the original object if it is no longer being used, or else a memory leak will result. Please see other methods on this class (particularly a corresponding method whose name begins with the word create) for alternatives that do not lead to these issues.; The CompartmentType object class is only available in SBML Level 2 Versions 2–4. It is not available in Level 1 nor Level 3.

See also: createCompartmentType()

def libsbml.Model.addConstraint	(	self,
		c
	)

Adds a copy of the given Constraint object to this Model.

addConstraint(Constraint c)   int

Parameters

c	the Constraint object to add.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: This method should be used with some caution. The fact that this method copies the object passed to it means that the caller will be left holding a physically different object instance than the one contained inside this object. Changes made to the original object instance (such as resetting attribute values) will not affect the instance in this object. In addition, the caller should make sure to free the original object if it is no longer being used, or else a memory leak will result. Please see other methods on this class (particularly a corresponding method whose name begins with the word create) for alternatives that do not lead to these issues.

See also: createConstraint()

def libsbml.SBase.addCVTerm	(	self,
		term,
		newBag = `False`
	)

inherited

Adds a copy of the given CVTerm object to this SBML object.

addCVTerm(CVTerm term, bool newBag)   int
addCVTerm(CVTerm term)   int

Parameters

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.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

LIBSBML_OPERATION_SUCCESS
LIBSBML_OPERATION_FAILED
LIBSBML_UNEXPECTED_ATTRIBUTE, if this object lacks a 'metaid' attribute
LIBSBML_INVALID_OBJECT

Note: Since the CV Term uses the 'metaid' attribute of the object as a reference, if the object has no 'metaid' attribute value set, then the CVTerm will not be added.; This method should be used with some caution. The fact that this method copies the object passed to it means that the caller will be left holding a physically different object instance than the one contained inside this object. Changes made to the original object instance (such as resetting attribute values) will not affect the instance in this object. In addition, the caller should make sure to free the original object if it is no longer being used, or else a memory leak will result. Please see other methods on this class (particularly a corresponding method whose name begins with the word create) for alternatives that do not lead to these issues.; Owing to the way that language interfaces are created in libSBML, this documentation may show methods that define default values for parameters with text that has the form parameter = value. This is not to be intepreted as a Python keyword argument; the use of a parameter name followed by an equals sign followed by a value is only meant to indicate a default value if the argument is not provided at all. It is not a keyword in the Python sense.

def libsbml.Model.addEvent	(	self,
		e
	)

Adds a copy of the given Event object to this Model.

addEvent(Event e)   int

Parameters

e	the Event object to add.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: This method should be used with some caution. The fact that this method copies the object passed to it means that the caller will be left holding a physically different object instance than the one contained inside this object. Changes made to the original object instance (such as resetting attribute values) will not affect the instance in this object. In addition, the caller should make sure to free the original object if it is no longer being used, or else a memory leak will result. Please see other methods on this class (particularly a corresponding method whose name begins with the word create) for alternatives that do not lead to these issues.

See also: createEvent()

def libsbml.Model.addFunctionDefinition	(	self,
		fd
	)

Adds a copy of the given FunctionDefinition object to this Model.

addFunctionDefinition(FunctionDefinition fd)   int

Parameters

fd	the FunctionDefinition to add.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: This method should be used with some caution. The fact that this method copies the object passed to it means that the caller will be left holding a physically different object instance than the one contained inside this object. Changes made to the original object instance (such as resetting attribute values) will not affect the instance in this object. In addition, the caller should make sure to free the original object if it is no longer being used, or else a memory leak will result. Please see other methods on this class (particularly a corresponding method whose name begins with the word create) for alternatives that do not lead to these issues.

See also: createFunctionDefinition()

def libsbml.Model.addInitialAssignment	(	self,
		ia
	)

Adds a copy of the given InitialAssignment object to this Model.

addInitialAssignment(InitialAssignment ia)   int

Parameters

ia	the InitialAssignment object to add.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: This method should be used with some caution. The fact that this method copies the object passed to it means that the caller will be left holding a physically different object instance than the one contained inside this object. Changes made to the original object instance (such as resetting attribute values) will not affect the instance in this object. In addition, the caller should make sure to free the original object if it is no longer being used, or else a memory leak will result. Please see other methods on this class (particularly a corresponding method whose name begins with the word create) for alternatives that do not lead to these issues.

See also: createInitialAssignment()

def libsbml.Model.addParameter	(	self,
		p
	)

Adds a copy of the given Parameter object to this Model.

addParameter(Parameter p)   int

Parameters

p	the Parameter object to add.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: This method should be used with some caution. The fact that this method copies the object passed to it means that the caller will be left holding a physically different object instance than the one contained inside this object. Changes made to the original object instance (such as resetting attribute values) will not affect the instance in this object. In addition, the caller should make sure to free the original object if it is no longer being used, or else a memory leak will result. Please see other methods on this class (particularly a corresponding method whose name begins with the word create) for alternatives that do not lead to these issues.

See also: createParameter()

def libsbml.Model.addReaction	(	self,
		r
	)

Adds a copy of the given Reaction object to this Model.

addReaction(Reaction r)   int

Parameters

r	the Reaction object to add.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: This method should be used with some caution. The fact that this method copies the object passed to it means that the caller will be left holding a physically different object instance than the one contained inside this object. Changes made to the original object instance (such as resetting attribute values) will not affect the instance in this object. In addition, the caller should make sure to free the original object if it is no longer being used, or else a memory leak will result. Please see other methods on this class (particularly a corresponding method whose name begins with the word create) for alternatives that do not lead to these issues.

See also: createReaction()

def libsbml.Model.addRule	(	self,
		r
	)

Adds a copy of the given Rule object to this Model.

addRule(Rule r)   int

Parameters

r	the Rule object to add.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: This method should be used with some caution. The fact that this method copies the object passed to it means that the caller will be left holding a physically different object instance than the one contained inside this object. Changes made to the original object instance (such as resetting attribute values) will not affect the instance in this object. In addition, the caller should make sure to free the original object if it is no longer being used, or else a memory leak will result. Please see other methods on this class (particularly a corresponding method whose name begins with the word create) for alternatives that do not lead to these issues.

See also: createAlgebraicRule(); createAssignmentRule(); createRateRule()

def libsbml.Model.addSpecies	(	self,
		s
	)

Adds a copy of the given Species object to this Model.

addSpecies(Species s)   int

Parameters

s	the Species object to add.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: This method should be used with some caution. The fact that this method copies the object passed to it means that the caller will be left holding a physically different object instance than the one contained inside this object. Changes made to the original object instance (such as resetting attribute values) will not affect the instance in this object. In addition, the caller should make sure to free the original object if it is no longer being used, or else a memory leak will result. Please see other methods on this class (particularly a corresponding method whose name begins with the word create) for alternatives that do not lead to these issues.

See also: createSpecies()

def libsbml.Model.addSpeciesType	(	self,
		st
	)

Adds a copy of the given SpeciesType object to this Model.

addSpeciesType(SpeciesType st)   int

Parameters

st	the SpeciesType object to add.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: This method should be used with some caution. The fact that this method copies the object passed to it means that the caller will be left holding a physically different object instance than the one contained inside this object. Changes made to the original object instance (such as resetting attribute values) will not affect the instance in this object. In addition, the caller should make sure to free the original object if it is no longer being used, or else a memory leak will result. Please see other methods on this class (particularly a corresponding method whose name begins with the word create) for alternatives that do not lead to these issues.; The SpeciesType object class is only available in SBML Level 2 Versions 2–4. It is not available in Level 1 nor Level 3.

See also: createSpeciesType()

def libsbml.Model.addUnitDefinition	(	self,
		ud
	)

Adds a copy of the given UnitDefinition object to this Model.

addUnitDefinition(UnitDefinition ud)   int

Parameters

ud	the UnitDefinition object to add.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: This method should be used with some caution. The fact that this method copies the object passed to it means that the caller will be left holding a physically different object instance than the one contained inside this object. Changes made to the original object instance (such as resetting attribute values) will not affect the instance in this object. In addition, the caller should make sure to free the original object if it is no longer being used, or else a memory leak will result. Please see other methods on this class (particularly a corresponding method whose name begins with the word create) for alternatives that do not lead to these issues.

See also: createUnitDefinition()

def libsbml.Model.appendAnnotation	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

appendAnnotation(XMLNode annotation)   int
appendAnnotation(string annotation)   int

Each variant is described separately below.

Method variant with the following signature:

appendAnnotation(XMLNode annotation)

Appends annotation content to any existing content in the 'annotation' subelement of this object.

The content in annotation is copied. Unlike setAnnotation(), this method allows other annotations to be preserved when an application adds its own data.

Parameters

annotation an XML structure that is to be copied and appended to the content of the 'annotation' subelement of this object.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

See also: setAnnotation()

Method variant with the following signature:

appendAnnotation(string annotation)

Appends annotation content to any existing content in the 'annotation' subelement of this object.

The content in annotation is copied. Unlike setAnnotation(), this method allows other annotations to be preserved when an application adds its own data.

Parameters

annotation an XML string that is to be copied and appended to the content of the 'annotation' subelement of this object.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

See also: setAnnotation()

def libsbml.Model.appendFrom	(	self,
		model
	)

Copies a given Model object's subcomponents and appends the copies to the appropriate places in this Model.

appendFrom(Model model)   int

This method also calls the appendFrom method on all libSBML plug-in objects.

: SBML Level 3 consists of a Core definition that can be extended via optional SBML Level 3 packages. A given model may indicate that it uses one or more SBML packages, and likewise, a software tool may be able to support one or more packages. LibSBML does not come preconfigured with all possible packages included and enabled, in part because not all package specifications have been finalized. To support the ability for software systems to enable support for the Level 3 packages they choose, libSBML features a plug-in mechanism. Each SBML Level 3 package is implemented in a separate code plug-in that can be enabled by the application to support working with that SBML package. A given SBML model may thus contain not only objects defined by SBML Level 3 Core, but also objects created by libSBML plug-ins supporting additional Level 3 packages.

Parameters

model the Model to merge with this one.

def libsbml.SBase.appendNotes	(	self,
		args
	)

inherited

This method has multiple variants; they differ in the arguments they accept.

appendNotes(XMLNode notes)   int
appendNotes(string notes)   int

Each variant is described separately below.

Method variant with the following signature:

appendNotes(string notes)

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.

Parameters

notes an XML string that is to appended to the content of the 'notes' subelement of this object.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

See also: getNotesString(); isSetNotes(); setNotes(); setNotes(); appendNotes(); unsetNotes(); SyntaxChecker.hasExpectedXHTMLSyntax()

Method variant with the following signature:

appendNotes(XMLNode notes)

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.

Parameters

notes an XML node structure that is to appended to the content of the 'notes' subelement of this object.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

See also: getNotesString(); isSetNotes(); setNotes(); setNotes(); appendNotes(); unsetNotes(); SyntaxChecker.hasExpectedXHTMLSyntax()

def libsbml.Model.clearAllElementIdList ( self )

Clears the internal list of the identifiers of all elements within this Model object.

clearAllElementIdList()

See also: populateAllElementIdList(); isPopulatedAllElementIdList()

def libsbml.Model.clearAllElementMetaIdList ( self )

Clears the internal list of the metaids of all elements within this Model object.

clearAllElementMetaIdList()

See also: populateAllElementMetaIdList(); isPopulatedAllElementMetaIdList()

def libsbml.Model.clone ( self )

Creates and returns a deep copy of this Model object.

clone()   Model

Returns: the (deep) copy of this Model object.

def libsbml.Model.connectToChild ( self )

connectToChild()

def libsbml.Model.createAlgebraicRule ( self )

Creates a new AlgebraicRule inside this Model and returns it.

createAlgebraicRule()   AlgebraicRule

The SBML Level and Version of the enclosing Model object, as well as any SBML package namespaces, are used to initialize this object's corresponding attributes.

Returns: the AlgebraicRule object created.

See also: addRule()

def libsbml.Model.createAssignmentRule ( self )

Creates a new AssignmentRule inside this Model and returns it.

createAssignmentRule()   AssignmentRule

The SBML Level and Version of the enclosing Model object, as well as any SBML package namespaces, are used to initialize this object's corresponding attributes.

Returns: the AssignmentRule object created.

See also: addRule()

def libsbml.Model.createCompartment ( self )

Creates a new Compartment inside this Model and returns it.

createCompartment()   Compartment

The SBML Level and Version of the enclosing Model object, as well as any SBML package namespaces, are used to initialize this object's corresponding attributes.

Returns: the Compartment object created.

See also: addCompartment()

def libsbml.Model.createCompartmentType ( self )

Creates a new CompartmentType inside this Model and returns it.

createCompartmentType()   CompartmentType

The SBML Level and Version of the enclosing Model object, as well as any SBML package namespaces, are used to initialize this object's corresponding attributes.

Returns: the CompartmentType object created.

Note: The CompartmentType object class is only available in SBML Level 2 Versions 2–4. It is not available in Level 1 nor Level 3.

See also: addCompartmentType()

def libsbml.Model.createConstraint ( self )

Creates a new Constraint inside this Model and returns it.

createConstraint()   Constraint

The SBML Level and Version of the enclosing Model object, as well as any SBML package namespaces, are used to initialize this object's corresponding attributes.

Returns: the Constraint object created.

See also: addConstraint()

def libsbml.Model.createDelay ( self )

Creates a new Delay inside the last Event object created in this Model, and returns a pointer to it.

createDelay()   Delay

The SBML Level and Version of the enclosing Model object, as well as any SBML package namespaces, are used to initialize this object's corresponding attributes.

: The mechanism by which the last Event object in this model was created is not significant. It could have been created in a variety of ways, for example by using createEvent(). If no Event object exists in this Model object, a new EventAssignment is not created and None is returned instead.

Returns: the Delay object created.

def libsbml.Model.createEvent ( self )

Creates a new Event inside this Model and returns it.

createEvent()   Event

The SBML Level and Version of the enclosing Model object, as well as any SBML package namespaces, are used to initialize this object's corresponding attributes.

Returns: the Event object created.

def libsbml.Model.createEventAssignment ( self )

Creates a new EventAssignment inside the last Event object created in this Model, and returns a pointer to it.

createEventAssignment()   EventAssignment

The SBML Level and Version of the enclosing Model object, as well as any SBML package namespaces, are used to initialize this object's corresponding attributes.

: The mechanism by which the last Event object in this model was created is not significant. It could have been created in a variety of ways, for example by using createEvent(). If no Event object exists in this Model object, a new EventAssignment is not created and None is returned instead.

Returns: the EventAssignment object created.

def libsbml.Model.createFunctionDefinition ( self )

Creates a new FunctionDefinition inside this Model and returns it.

createFunctionDefinition()   FunctionDefinition

The SBML Level and Version of the enclosing Model object, as well as any SBML package namespaces, are used to initialize this object's corresponding attributes.

Returns: the FunctionDefinition object created.

See also: addFunctionDefinition()

def libsbml.Model.createInitialAssignment ( self )

Creates a new InitialAssignment inside this Model and returns it.

createInitialAssignment()   InitialAssignment

The SBML Level and Version of the enclosing Model object, as well as any SBML package namespaces, are used to initialize this object's corresponding attributes.

Returns: the InitialAssignment object created.

See also: addInitialAssignment()

def libsbml.Model.createKineticLaw ( self )

Creates a new KineticLaw inside the last Reaction object created in this Model, and returns a pointer to it.

createKineticLaw()   KineticLaw

The SBML Level and Version of the enclosing Model object, as well as any SBML package namespaces, are used to initialize this object's corresponding attributes.

: The mechanism by which the last Reaction object was created and added to this Model is not significant. It could have been created in a variety of ways, for example using createReaction(). If a Reaction does not exist for this model, a new SpeciesReference is not created and None is returned instead.

Returns: the KineticLaw object created. If a Reaction does not exist for this model, or a Reaction does exist but already has a KineticLaw, a new KineticLaw is not created and None is returned.

def libsbml.Model.createKineticLawLocalParameter ( self )

Creates a new LocalParameter inside the KineticLaw object of the last Reaction created inside this Model, and returns a pointer to it.

createKineticLawLocalParameter()   LocalParameter

The SBML Level and Version of the enclosing Model object, as well as any SBML package namespaces, are used to initialize this object's corresponding attributes.

: The last KineticLaw object in this Model could have been created in a variety of ways. For example, it could have been added using createKineticLaw(), or it could be the result of using Reaction.createKineticLaw() on the Reaction object created by a createReaction(). If a Reaction does not exist for this model, or the last Reaction does not contain a KineticLaw object, a new Parameter is not created and None is returned instead.

Returns: the Parameter object created. If a Reaction does not exist for this model, or a KineticLaw for the Reaction does not exist, a new Parameter is not created and None is returned.

def libsbml.Model.createKineticLawParameter ( self )

Creates a new local Parameter inside the KineticLaw object of the last Reaction created inside this Model, and returns a pointer to it.

createKineticLawParameter()   Parameter

The SBML Level and Version of the enclosing Model object, as well as any SBML package namespaces, are used to initialize this object's corresponding attributes.

: The last KineticLaw object in this Model could have been created in a variety of ways. For example, it could have been added using createKineticLaw(), or it could be the result of using Reaction.createKineticLaw() on the Reaction object created by a createReaction(). If a Reaction does not exist for this model, or the last Reaction does not contain a KineticLaw object, a new Parameter is not created and None is returned instead.

Returns: the Parameter object created. If a Reaction does not exist for this model, or a KineticLaw for the Reaction does not exist, a new Parameter is not created and None is returned.

def libsbml.Model.createModifier ( self )

Creates a new ModifierSpeciesReference object for a modifier species inside the last Reaction object in this Model, and returns a pointer to it.

createModifier()   ModifierSpeciesReference

The SBML Level and Version of the enclosing Model object, as well as any SBML package namespaces, are used to initialize this object's corresponding attributes.

: The mechanism by which the last Reaction object was created and added to this Model is not significant. It could have been created in a variety of ways, for example using createReaction(). If a Reaction does not exist for this model, a new SpeciesReference is not created and None is returned instead.

Returns: the SpeciesReference object created. If a Reaction does not exist for this model, a new SpeciesReference is not created and None is returned.

def libsbml.Model.createParameter ( self )

Creates a new Parameter inside this Model and returns it.

createParameter()   Parameter

The SBML Level and Version of the enclosing Model object, as well as any SBML package namespaces, are used to initialize this object's corresponding attributes.

Returns: the Parameter object created.

See also: addParameter()

def libsbml.Model.createProduct ( self )

Creates a new SpeciesReference object for a product inside the last Reaction object in this Model, and returns a pointer to it.

createProduct()   SpeciesReference

The SBML Level and Version of the enclosing Model object, as well as any SBML package namespaces, are used to initialize this object's corresponding attributes.

: The mechanism by which the last Reaction object was created and added to this Model is not significant. It could have been created in a variety of ways, for example using createReaction(). If a Reaction does not exist for this model, a new SpeciesReference is not created and None is returned instead.

Returns: the SpeciesReference object created. If a Reaction does not exist for this model, a new SpeciesReference is not created and None is returned.

def libsbml.Model.createRateRule ( self )

Creates a new RateRule inside this Model and returns it.

createRateRule()   RateRule

The SBML Level and Version of the enclosing Model object, as well as any SBML package namespaces, are used to initialize this object's corresponding attributes.

Returns: the RateRule object created.

See also: addRule()

def libsbml.Model.createReactant ( self )

Creates a new SpeciesReference object for a reactant inside the last Reaction object in this Model, and returns a pointer to it.

createReactant()   SpeciesReference

The SBML Level and Version of the enclosing Model object, as well as any SBML package namespaces, are used to initialize this object's corresponding attributes.

: The mechanism by which the last Reaction object was created and added to this Model is not significant. It could have been created in a variety of ways, for example using createReaction(). If a Reaction does not exist for this model, a new SpeciesReference is not created and None is returned instead.

Returns: the SpeciesReference object created. If a Reaction does not exist for this model, a new SpeciesReference is not created and None is returned.

def libsbml.Model.createReaction ( self )

Creates a new Reaction inside this Model and returns it.

createReaction()   Reaction

The SBML Level and Version of the enclosing Model object, as well as any SBML package namespaces, are used to initialize this object's corresponding attributes.

Returns: the Reaction object created.

See also: addReaction()

def libsbml.Model.createSpecies ( self )

Creates a new Species inside this Model and returns it.

createSpecies()   Species

The SBML Level and Version of the enclosing Model object, as well as any SBML package namespaces, are used to initialize this object's corresponding attributes.

Returns: the Species object created.

See also: addSpecies()

def libsbml.Model.createSpeciesType ( self )

Creates a new SpeciesType inside this Model and returns it.

createSpeciesType()   SpeciesType

The SBML Level and Version of the enclosing Model object, as well as any SBML package namespaces, are used to initialize this object's corresponding attributes.

Returns: the SpeciesType object created.

Note: The SpeciesType object class is only available in SBML Level 2 Versions 2–4. It is not available in Level 1 nor Level 3.

See also: addSpeciesType()

def libsbml.Model.createTrigger ( self )

Creates a new Trigger inside the last Event object created in this Model, and returns a pointer to it.

createTrigger()   Trigger

The SBML Level and Version of the enclosing Model object, as well as any SBML package namespaces, are used to initialize this object's corresponding attributes.

: The mechanism by which the last Event object in this model was created is not significant. It could have been created in a variety of ways, for example by using createEvent(). If no Event object exists in this Model object, a new EventAssignment is not created and None is returned instead.

Returns: the Trigger object created.

def libsbml.Model.createUnit ( self )

Creates a new Unit object within the last UnitDefinition object created in this model and returns a pointer to it.

createUnit()   Unit

The SBML Level and Version of the enclosing Model object, as well as any SBML package namespaces, are used to initialize this object's corresponding attributes.

The mechanism by which the UnitDefinition was created is not significant. If a UnitDefinition object does not exist in this model, a new Unit is not created and None is returned instead.

Returns: the Unit object created.

See also: addUnitDefinition()

def libsbml.Model.createUnitDefinition ( self )

Creates a new UnitDefinition inside this Model and returns it.

createUnitDefinition()   UnitDefinition

The SBML Level and Version of the enclosing Model object, as well as any SBML package namespaces, are used to initialize this object's corresponding attributes.

Returns: the UnitDefinition object created.

See also: addUnitDefinition()

def libsbml.SBase.deleteDisabledPlugins	(	self,
		recursive = `True`
	)

inherited

Deletes all information stored in disabled plugins.

deleteDisabledPlugins(bool recursive)
deleteDisabledPlugins()

If the plugin is re-enabled later, it will then not have any previously-stored information.

: SBML Level 3 consists of a Core definition that can be extended via optional SBML Level 3 packages. A given model may indicate that it uses one or more SBML packages, and likewise, a software tool may be able to support one or more packages. LibSBML does not come preconfigured with all possible packages included and enabled, in part because not all package specifications have been finalized. To support the ability for software systems to enable support for the Level 3 packages they choose, libSBML features a plug-in mechanism. Each SBML Level 3 package is implemented in a separate code plug-in that can be enabled by the application to support working with that SBML package. A given SBML model may thus contain not only objects defined by SBML Level 3 Core, but also objects created by libSBML plug-ins supporting additional Level 3 packages.

: If a plugin is disabled, the package information it contains is no longer considered to be part of the SBML document for the purposes of searching the document or writing out the document. However, the information is still retained, so if the plugin is enabled again, the same information will once again be available, and will be written out to the final model.

Parameters

recursive if True, the disabled information will be deleted also from all child elements, otherwise only from this SBase element.

See also: getNumDisabledPlugins()

def libsbml.SBase.disablePackage	(	self,
		pkgURI,
		pkgPrefix
	)

inherited

Disables the given SBML Level 3 package on this object.

disablePackage(string pkgURI, string pkgPrefix)   int

This method disables the specified package on this object and other objects connected by child-parent links in the same SBMLDocument object.

An example of when this may be useful is during construction of model components when mixing existing and new models. Suppose your application read an SBML document containing a model that used the SBML Hierarchical Model Composition (“comp”) package, and extracted parts of that model in order to construct a new model in memory. The new, in-memory model will not accept a component drawn from an other SBMLDocument with different package namespace declarations. You could reconstruct the same namespaces in the in-memory model first, but as a shortcut, you could also disable the package namespace on the object being added. Here is a code example to help clarify this:

 import sys
 import os.path
 from libsbml import *
 
 # We read an SBML L3V1 model that uses the 'comp' package.
 
 doc = readSBML('sbml-file-with-comp-elements.xml');
 if doc.getNumErrors() > 0:
   print('readSBML encountered errors while reading the file.')
   doc.printErrors()
   sys.exit(1)
 
 # We extract one of the species from the model.
 
 model = doc.getModel()
 if model == None:
   print('Unable to retrieve Model object')
   sys.exit(1)
 
 s1 = model.getSpecies(0)
 if s1 == None:
   print('Unable to retrieve Species object')
   sys.exit(1)
 
 # We construct a new model.
 # This model does not use the 'comp' package.
 
 try:
   newDoc = SBMLDocument(3, 1)
 except ValueError:
   print('Could not create SBMLDocument object')
   sys.exit(1)
 
 newModel = newDoc.createModel()
 if newModel == None:
   print('Unable to create new Model object')
   sys.exit(1)
 
 # The following would normally fail with an error, because
 # addSpecies() would first check that the parent of the given
 # object has namespaces declared, and will discover that s1
 # does but newModel does not.
 
 #   newModel.addSpecies(s1)
 
 # However, if we disable the 'comp' package on s1, then the
 # call to addSpecies will work.
 
 compNS = 'http://www.sbml.org/sbml/level3/version1/comp/version1'
 status = s1.disablePackage(compNS, 'comp')
 if status != LIBSBML_OPERATION_SUCCESS:
   print('Unable to disable package.')
   sys.exit(1)
 
 newSpecies = newModel.addSpecies(s1)   # This will work now.
 if newSpecies == None:
   print('Could not add Species')       # (This will not happen,
   sys.exit(1)                          # but always check errors.)

Parameters

pkgURI	the URI of the package.
pkgPrefix	the XML prefix of the package.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

See also: enablePackage()

def libsbml.SBase.enablePackage	(	self,
		pkgURI,
		pkgPrefix,
		flag
	)

inherited

Enables or disables the given SBML Level 3 package on this object.

enablePackage(string pkgURI, string pkgPrefix, bool flag)   int

This method enables the specified package on this object and other objects connected by child-parent links in the same SBMLDocument object. This method is the converse of SBase.disablePackage().

Parameters

pkgURI	the URI of the package.
pkgPrefix	the XML prefix of the package.
flag	whether to enable (`True`) or disable (`False`) the package.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

See also: disablePackage()

def libsbml.Model.getAllElementIdList ( self )

Returns the internal list of the identifiers of all elements within this Model object.

getAllElementIdList()   IdList

Returns: an IdList of all the identifiers in the model.

See also: populateAllElementIdList(); isPopulatedAllElementIdList()

def libsbml.Model.getAllElementMetaIdList ( self )

Returns the internal list of the metaids of all elements within this Model object.

getAllElementMetaIdList()   IdList

Returns: an IdList of all the metaids in the model.

See also: populateAllElementMetaIdList(); isPopulatedAllElementMetaIdList()

def libsbml.SBase.getAncestorOfType	(	self,
		args
	)

inherited

This method has multiple variants; they differ in the arguments they accept.

getAncestorOfType(int type, string pkgName)   SBase
getAncestorOfType(int type)   SBase

Each variant is described separately below.

Method variant with the following signature:

getAncestorOfType(int type, string pkgName = 'core')

Returns the first ancestor object that has the given SBML type code from the given package.

LibSBML attaches an identifying code to every kind of SBML object. These are known as SBML type codes. In the Python 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 from the given pkgName.

Parameters

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.

Returns: the ancestor SBML object of this SBML object that corresponds to the given SBML object type code, or None if no ancestor exists.

Warning: The optional argument pkgName must be used for all type codes from SBML Level 3 packages. Otherwise, the function will search the 'core' namespace alone, not find any corresponding elements, and return None.

Note: Owing to the way that language interfaces are created in libSBML, this documentation may show methods that define default values for parameters with text that has the form parameter = value. This is not to be intepreted as a Python keyword argument; the use of a parameter name followed by an equals sign followed by a value is only meant to indicate a default value if the argument is not provided at all. It is not a keyword in the Python sense.

Method variant with the following signature:

getAncestorOfType(int type, string pkgName = 'core')

Returns the first ancestor object that has the given SBML type code from the given package.

LibSBML attaches an identifying code to every kind of SBML object. These are known as SBML type codes. In the Python 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 from the given pkgName.

Parameters

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.

Returns: the ancestor SBML object of this SBML object that corresponds to the given SBML object type code, or None if no ancestor exists.

Warning: The optional argument pkgName must be used for all type codes from SBML Level 3 packages. Otherwise, the function will search the 'core' namespace alone, not find any corresponding elements, and return None.

Note: Owing to the way that language interfaces are created in libSBML, this documentation may show methods that define default values for parameters with text that has the form parameter = value. This is not to be intepreted as a Python keyword argument; the use of a parameter name followed by an equals sign followed by a value is only meant to indicate a default value if the argument is not provided at all. It is not a keyword in the Python sense.

def libsbml.SBase.getAnnotation	(	self,
		args
	)

inherited

Returns the content of the 'annotation' subelement of this object as a tree of XMLNode objects.

getAnnotation()   XMLNode

: 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.

Returns: the annotation of this SBML object as a tree of XMLNode objects.

See also: getAnnotationString(); isSetAnnotation(); setAnnotation(); setAnnotation(); appendAnnotation(); appendAnnotation(); unsetAnnotation()

def libsbml.SBase.getAnnotationString	(	self,
		args
	)

inherited

Returns the content of the 'annotation' subelement of this object as a character string.

getAnnotationString()   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. See the method getAnnotation() for a version that returns annotations in XML form.

Returns: the annotation of this SBML object as a character string.

See also: getAnnotation(); isSetAnnotation(); setAnnotation(); setAnnotation(); appendAnnotation(); appendAnnotation(); unsetAnnotation()

def libsbml.Model.getAreaUnits ( self )

Returns the value of the 'areaUnits' attribute of this Model.

getAreaUnits()   string

Returns: the areaUnits of this Model.

Note: The 'areaUnits' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

def libsbml.Model.getAssignmentRule	(	self,
		args
	)

Get a Rule object based on the variable to which it assigns a value.

getAssignmentRule(string variable)   AssignmentRule

Parameters

variable the variable to search for.

Returns: the Rule in this Model with the given 'variable' attribute value or None if no such Rule exists.

def libsbml.Model.getAssignmentRuleByVariable	(	self,
		args
	)

Get a Rule object based on the variable to which it assigns a value.

getAssignmentRuleByVariable(string variable)   AssignmentRule

Parameters

variable the variable to search for.

Returns: the Rule in this Model with the given 'variable' attribute value or None if no such Rule exists.

def libsbml.SBase.getColumn ( self )

inherited

Returns the column number where this object first appears in the XML representation of the SBML document.

getColumn()   long

Returns: the column number of this SBML object. If this object was created programmatically and not read from a file, this method will return the value 0.

Note: The column number for each construct in an SBML model is set upon reading the model. The accuracy of the column number depends on the correctness of the XML representation of the model, and on the particular XML parser library being used. The former limitation relates to the following problem: if the model is actually invalid XML, then the parser may not be able to interpret the data correctly and consequently may not be able to establish the real column number. The latter limitation is simply that different parsers seem to have their own accuracy limitations, and out of all the parsers supported by libSBML, none have been 100% accurate in all situations. (At this time, libSBML supports the use of libxml2, Expat and Xerces.)

See also: getLine()

def libsbml.Model.getCompartment	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

getCompartment(long  n)   Compartment
getCompartment(string sid)   Compartment

Each variant is described separately below.

Method variant with the following signature:

getCompartment(long n)

Get the nth Compartment object in this Model.

Parameters

n	the index of the object to return.

Returns: the nth Compartment of this Model. If the index n is invalid, None is returned.

Method variant with the following signature:

getCompartment(string sid)

Get a Compartment object based on its identifier.

Parameters

sid	the identifier to search for.

Returns: the Compartment in this Model with the identifier sid or None if no such Compartment exists.

def libsbml.Model.getCompartmentType	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

getCompartmentType(long  n)   CompartmentType
getCompartmentType(string sid)   CompartmentType

Each variant is described separately below.

Method variant with the following signature:

getCompartmentType(long n)

Get the nth CompartmentType object in this Model.

Parameters

n	the index of the object to return.

Returns: the nth CompartmentType of this Model. If the index n is invalid, None is returned.

Note: The CompartmentType object class is only available in SBML Level 2 Versions 2–4. It is not available in Level 1 nor Level 3.

Method variant with the following signature:

getCompartmentType(string sid)

Get a CompartmentType object based on its identifier.

Parameters

sid	the identifier to search for.

Returns: the CompartmentType in this Model with the identifier sid or None if no such CompartmentType exists.

Note: The CompartmentType object class is only available in SBML Level 2 Versions 2–4. It is not available in Level 1 nor Level 3.

def libsbml.Model.getConstraint	(	self,
		args
	)

Get the nth Constraint object in this Model.

getConstraint(long  n)   Constraint

Parameters

n	the index of the object to return.

Returns: the nth Constraint of this Model. If the index n is invalid, None is returned.

def libsbml.Model.getConversionFactor ( self )

Returns the value of the 'conversionFactor' attribute of this Model.

getConversionFactor()   string

Returns: the conversionFactor of this Model.

Note: The 'conversionFactor' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

def libsbml.SBase.getCVTerm	(	self,
		n
	)

inherited

Returns the nth CVTerm in the list of CVTerms of this SBML object.

getCVTerm(long  n)   CVTerm

Parameters

n	long the index of the CVTerm to retrieve.

Returns: the nth CVTerm in the list of CVTerms for this SBML object. If the index n is invalid, None is returned.

def libsbml.SBase.getCVTerms	(	self,
		args
	)

inherited

Returns a list of CVTerm objects in the annotations of this SBML object.

getCVTerms()   List *

Returns: the list of CVTerms for this SBML object.

def libsbml.SBase.getDisabledPlugin	(	self,
		args
	)

inherited

Returns the nth disabled plug-in object (extension interface) for an SBML Level 3 package extension.

getDisabledPlugin(long  n)   SBasePlugin

If no such plugin exists, None is returned.

: SBML Level 3 consists of a Core definition that can be extended via optional SBML Level 3 packages. A given model may indicate that it uses one or more SBML packages, and likewise, a software tool may be able to support one or more packages. LibSBML does not come preconfigured with all possible packages included and enabled, in part because not all package specifications have been finalized. To support the ability for software systems to enable support for the Level 3 packages they choose, libSBML features a plug-in mechanism. Each SBML Level 3 package is implemented in a separate code plug-in that can be enabled by the application to support working with that SBML package. A given SBML model may thus contain not only objects defined by SBML Level 3 Core, but also objects created by libSBML plug-ins supporting additional Level 3 packages.

: If a plugin is disabled, the package information it contains is no longer considered to be part of the SBML document for the purposes of searching the document or writing out the document. However, the information is still retained, so if the plugin is enabled again, the same information will once again be available, and will be written out to the final model.

Parameters

n	the index of the disabled plug-in to return.

Returns: the nth disabled plug-in object (the libSBML extension interface) of a package extension. If the index n is invalid, None is returned.

See also: getNumDisabledPlugins(); getPlugin()

def libsbml.Model.getElementByMetaId	(	self,
		metaid
	)

Returns the first child element it can find with the given metaid.

getElementByMetaId(string metaid)   SBase

Parameters

metaid string representing the meta-identifier of the object to find.

Returns: pointer to the first element found with the given metaid, or None if no such object is found.

def libsbml.Model.getElementBySId	(	self,
		id
	)

Returns the first child element found that has the given id.

getElementBySId(string id)   SBase

This operation searches the model-wide SId identifier type namespace

Parameters

id	string representing the id of the object to find.

Returns: pointer to the first element found with the given id, or None if no such object is found.

def libsbml.Model.getElementName ( self )

Returns the XML element name of this object, which for Model, is always 'model'.

getElementName()   string

Returns: the name of this element, i.e., 'model'.

def libsbml.Model.getEvent	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

getEvent(long  n)   Event
getEvent(string sid)   Event

Each variant is described separately below.

Method variant with the following signature:

getEvent(long n)

Get the nth Event object in this Model.

Parameters

n	the index of the object to return.

Returns: the nth Event of this Model. If the index n is invalid, None is returned.

Method variant with the following signature:

getEvent(string sid)

Get an Event object based on its identifier.

Parameters

sid	the identifier to search for.

Returns: the Event in this Model with the identifier sid or None if no such Event exists.

def libsbml.Model.getExtentUnits ( self )

Returns the value of the 'extentUnits' attribute of this Model.

getExtentUnits()   string

Returns: the extentUnits of this Model.

Note: The 'extentUnits' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

def libsbml.Model.getFunctionDefinition	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

getFunctionDefinition(long  n)   FunctionDefinition
getFunctionDefinition(string sid)   FunctionDefinition

Each variant is described separately below.

Method variant with the following signature:

getFunctionDefinition(long n)

Get the nth FunctionDefinitions object in this Model.

Parameters

n	the index of the object to return.

Returns: the nth FunctionDefinition of this Model. If the index n is invalid, None is returned.

Method variant with the following signature:

getFunctionDefinition(string sid)

Get a FunctionDefinition object based on its identifier.

Parameters

sid	the identifier to search for.

Returns: the FunctionDefinition in this Model with the identifier sid or None if no such FunctionDefinition exists.

def libsbml.Model.getId ( self )

Returns the value of the 'id' attribute of this Model.

getId()   string

Note: Because of the inconsistent behavior of this function with respect to assignments and rules, it is now recommended to use the getIdAttribute() function instead.

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 SId or a type derived from that, such as UnitSId, depending on the object in question. All data types are defined as follows:

letter ::= 'a'..'z','A'..'Z'
digit  ::= '0'..'9'
idChar ::= letter | digit | '_'
SId    ::= ( letter | '_' ) idChar*

The characters ( and ) are used for grouping, the character * 'zero or more times', and the character | indicates logical 'or'. The equality of SBML identifiers is determined by an exact character sequence match; i.e., comparisons must be performed in a case-sensitive manner. This applies to all uses of SId, SIdRef, and derived types.

Users need to be aware of some important API issues that are the result of the history of SBML and libSBML. Prior to SBML Level 3 Version 2, SBML defined 'id' and 'name' attributes on only a subset of SBML objects. To simplify the work of programmers, libSBML's API provided get, set, check, and unset on the SBase object class itself instead of on individual subobject classes. This made the get/set/etc. methods uniformly available on all objects in the libSBML API. LibSBML simply returned empty strings or otherwise did not act when the methods were applied to SBML objects that were not defined by the SBML specification to have 'id' or 'name' attributes. Additional complications arose with the rule and assignment objects: InitialAssignment, EventAssignment, AssignmentRule, and RateRule. In early versions of SBML, the rule object hierarchy was different, and in addition, then as now, they possess different attributes: 'variable' (for the rules and event assignments), 'symbol' (for initial assignments), or neither (for algebraic rules). Prior to SBML Level 3 Version 2, getId() would always return an empty string, and isSetId() would always return False for objects of these classes.

With the addition of 'id' and 'name' attributes on SBase in Level 3 Version 2, it became necessary to introduce a new way to interact with the attributes more consistently in libSBML to avoid breaking backward compatibility in the behavior of the original 'id' methods. For this reason, libSBML provides four functions (getIdAttribute(), setIdAttribute(), isSetIdAttribute(), and unsetIdAttribute()) that always act on the actual 'id' attribute inherited from SBase, regardless of the object's type. These new methods should be used instead of the older getId()/setId()/etc. methods unless the old behavior is somehow necessary. Regardless of the Level and Version of the SBML, these functions allow client applications to use more generalized code in some situations (for instance, when manipulating objects that are all known to have identifiers). If the object in question does not posess an 'id' attribute according to the SBML specification for the Level and Version in use, libSBML will not allow the identifier to be set, nor will it read or write 'id' attributes for those objects.

Returns: the id of this Model.

See also: getIdAttribute(); setIdAttribute(); isSetIdAttribute(); unsetIdAttribute()

def libsbml.SBase.getIdAttribute ( self )

inherited

Returns the value of the 'id' attribute of this SBML object.

getIdAttribute()   string

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 SId or a type derived from that, such as UnitSId, depending on the object in question. All data types are defined as follows:

letter ::= 'a'..'z','A'..'Z'
digit  ::= '0'..'9'
idChar ::= letter | digit | '_'
SId    ::= ( letter | '_' ) idChar*

The characters ( and ) are used for grouping, the character * 'zero or more times', and the character | indicates logical 'or'. The equality of SBML identifiers is determined by an exact character sequence match; i.e., comparisons must be performed in a case-sensitive manner. This applies to all uses of SId, SIdRef, and derived types.

Users need to be aware of some important API issues that are the result of the history of SBML and libSBML. Prior to SBML Level 3 Version 2, SBML defined 'id' and 'name' attributes on only a subset of SBML objects. To simplify the work of programmers, libSBML's API provided get, set, check, and unset on the SBase object class itself instead of on individual subobject classes. This made the get/set/etc. methods uniformly available on all objects in the libSBML API. LibSBML simply returned empty strings or otherwise did not act when the methods were applied to SBML objects that were not defined by the SBML specification to have 'id' or 'name' attributes. Additional complications arose with the rule and assignment objects: InitialAssignment, EventAssignment, AssignmentRule, and RateRule. In early versions of SBML, the rule object hierarchy was different, and in addition, then as now, they possess different attributes: 'variable' (for the rules and event assignments), 'symbol' (for initial assignments), or neither (for algebraic rules). Prior to SBML Level 3 Version 2, getId() would always return an empty string, and isSetId() would always return False for objects of these classes.

With the addition of 'id' and 'name' attributes on SBase in Level 3 Version 2, it became necessary to introduce a new way to interact with the attributes more consistently in libSBML to avoid breaking backward compatibility in the behavior of the original 'id' methods. For this reason, libSBML provides four functions (getIdAttribute(), setIdAttribute(), isSetIdAttribute(), and unsetIdAttribute()) that always act on the actual 'id' attribute inherited from SBase, regardless of the object's type. These new methods should be used instead of the older getId()/setId()/etc. methods unless the old behavior is somehow necessary. Regardless of the Level and Version of the SBML, these functions allow client applications to use more generalized code in some situations (for instance, when manipulating objects that are all known to have identifiers). If the object in question does not posess an 'id' attribute according to the SBML specification for the Level and Version in use, libSBML will not allow the identifier to be set, nor will it read or write 'id' attributes for those objects.

Returns: the id of this SBML object, if set and valid for this level and version of SBML; an empty string otherwise.

Note: Because of the inconsistent behavior of this function with respect to assignments and rules, callers should use getIdAttribute() instead.

See also: setIdAttribute(); isSetIdAttribute(); unsetIdAttribute()

def libsbml.Model.getInitialAssignment	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

getInitialAssignment(long  n)   InitialAssignment
getInitialAssignment(string symbol)   InitialAssignment

Each variant is described separately below.

Method variant with the following signature:

getInitialAssignment(string symbol)

Get an InitialAssignment object based on the symbol to which it assigns a value.

Parameters

symbol the symbol to search for.

Returns: the InitialAssignment in this Model with the given 'symbol' attribute value or None if no such InitialAssignment exists.

Method variant with the following signature:

getInitialAssignment(long n)

Get the nth InitialAssignment object in this Model.

Parameters

n	the index of the object to return.

Returns: the nth InitialAssignment of this Model. If the index n is invalid, None is returned.

def libsbml.Model.getInitialAssignmentBySymbol	(	self,
		args
	)

Get an InitialAssignment object based on the symbol to which it assigns a value.

getInitialAssignmentBySymbol(string symbol)   InitialAssignment

Parameters

symbol the symbol to search for.

Returns: the InitialAssignment in this Model with the given 'symbol' attribute value or None if no such InitialAssignment exists.

def libsbml.Model.getLengthUnits ( self )

Returns the value of the 'lengthUnits' attribute of this Model.

getLengthUnits()   string

Returns: the lengthUnits of this Model.

Note: The 'lengthUnits' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

def libsbml.SBase.getLevel ( self )

inherited

Returns the SBML Level of the SBMLDocument object containing this object.

getLevel()   long

: 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.)

Returns: the SBML level of this SBML object.

See also: getVersion(); getNamespaces(); getPackageVersion()

def libsbml.SBase.getLine ( self )

inherited

Returns the line number where this object first appears in the XML representation of the SBML document.

getLine()   long

Returns: the line number of this SBML object. If this object was created programmatically and not read from a file, this method will return the value 0.

Note: The line number for each construct in an SBML model is set upon reading the model. The accuracy of the line number depends on the correctness of the XML representation of the model, and on the particular XML parser library being used. The former limitation relates to the following problem: if the model is actually invalid XML, then the parser may not be able to interpret the data correctly and consequently may not be able to establish the real line number. The latter limitation is simply that different parsers seem to have their own accuracy limitations, and out of all the parsers supported by libSBML, none have been 100% accurate in all situations. (At this time, libSBML supports the use of libxml2, Expat and Xerces.)

See also: getColumn()

def libsbml.SBase.getListOfAllElements	(	self,
		filter = `None`
	)

inherited

Returns an SBaseList of all child SBase objects, including those nested to an arbitrary depth.

getListOfAllElements(ElementFilter filter)   SBaseList
getListOfAllElements()   SBaseList

Returns: a list of all objects that are children of this object.

def libsbml.SBase.getListOfAllElementsFromPlugins	(	self,
		filter = `None`
	)

inherited

Returns a List of all child SBase objects contained in SBML package plug-ins.

getListOfAllElementsFromPlugins(ElementFilter filter)   SBaseList
getListOfAllElementsFromPlugins()   SBaseList

: SBML Level 3 consists of a Core definition that can be extended via optional SBML Level 3 packages. A given model may indicate that it uses one or more SBML packages, and likewise, a software tool may be able to support one or more packages. LibSBML does not come preconfigured with all possible packages included and enabled, in part because not all package specifications have been finalized. To support the ability for software systems to enable support for the Level 3 packages they choose, libSBML features a plug-in mechanism. Each SBML Level 3 package is implemented in a separate code plug-in that can be enabled by the application to support working with that SBML package. A given SBML model may thus contain not only objects defined by SBML Level 3 Core, but also objects created by libSBML plug-ins supporting additional Level 3 packages.

This method walks down the list of all SBML Level 3 packages used by this object and returns all child objects defined by those packages.

Returns: a pointer to a List of pointers to all children objects from plug-ins.

def libsbml.Model.getListOfCompartments	(	self,
		args
	)

Get the ListOfCompartments object in this Model.

getListOfCompartments()   ListOfCompartments

Returns: the list of Compartments for this Model.

def libsbml.Model.getListOfCompartmentTypes	(	self,
		args
	)

Get the ListOfCompartmentTypes object in this Model.

getListOfCompartmentTypes()   ListOfCompartmentTypes

Returns: the list of CompartmentTypes for this Model.

Note: The CompartmentType object class is only available in SBML Level 2 Versions 2–4. It is not available in Level 1 nor Level 3.

def libsbml.Model.getListOfConstraints	(	self,
		args
	)

Get the ListOfConstraints object in this Model.

getListOfConstraints()   ListOfConstraints

Returns: the list of Constraints for this Model.

def libsbml.Model.getListOfEvents	(	self,
		args
	)

Get the ListOfEvents object in this Model.

getListOfEvents()   ListOfEvents

Returns: the list of Events for this Model.

def libsbml.Model.getListOfFunctionDefinitions	(	self,
		args
	)

Get the ListOfFunctionDefinitions object in this Model.

getListOfFunctionDefinitions()   ListOfFunctionDefinitions

Returns: the list of FunctionDefinitions for this Model.

def libsbml.Model.getListOfInitialAssignments	(	self,
		args
	)

Get the ListOfInitialAssignments object in this Model.

getListOfInitialAssignments()   ListOfInitialAssignments

Returns: the list of InitialAssignments for this Model.

def libsbml.Model.getListOfParameters	(	self,
		args
	)

Get the ListOfParameters object in this Model.

getListOfParameters()   ListOfParameters

Returns: the list of Parameters for this Model.

def libsbml.Model.getListOfReactions	(	self,
		args
	)

Get the ListOfReactions object in this Model.

getListOfReactions()   ListOfReactions

Returns: the list of Reactions for this Model.

def libsbml.Model.getListOfRules	(	self,
		args
	)

Get the ListOfRules object in this Model.

getListOfRules()   ListOfRules

Returns: the list of Rules for this Model.

def libsbml.Model.getListOfSpecies	(	self,
		args
	)

Get the ListOfSpecies object in this Model.

getListOfSpecies()   ListOfSpecies

Returns: the list of Species for this Model.

def libsbml.Model.getListOfSpeciesTypes	(	self,
		args
	)

Get the ListOfSpeciesTypes object in this Model.

getListOfSpeciesTypes()   ListOfSpeciesTypes

Returns: the list of SpeciesTypes for this Model.

Note: The SpeciesType object class is only available in SBML Level 2 Versions 2–4. It is not available in Level 1 nor Level 3.

def libsbml.Model.getListOfUnitDefinitions	(	self,
		args
	)

Get the ListOfUnitDefinitions object in this Model.

getListOfUnitDefinitions()   ListOfUnitDefinitions

Returns: the list of UnitDefinitions for this Model.

def libsbml.SBase.getMetaId ( self )

inherited

Returns the value of the 'metaid' attribute of this SBML object.

getMetaId()   string

: 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. The latter point is important, because the uniqueness criterion applies across any attribute with type ID anywhere in the file, 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 the XML ID type. Although SBML itself specifies the use of XML ID only for the 'metaid' attribute, SBML-compatible applications 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. Finally, note that LibSBML does not provide an explicit XML ID data type; it uses ordinary character strings, which is easier for applications to support.

Returns: the meta-identifier of this SBML object.

See also: isSetMetaId(); setMetaId()

def libsbml.SBase.getModel ( self )

inherited

Returns the Model object for the SBML Document in which the current object is located.

getModel()   Model

Returns: the Model object for the SBML Document of this SBML object.

See also: getParentSBMLObject(); getSBMLDocument()

def libsbml.SBase.getModelHistory	(	self,
		args
	)

inherited

Returns the ModelHistory object, if any, attached to this object.

getModelHistory()   ModelHistory

Returns: the ModelHistory object attached to this object, or None if none exist.

Note: In SBML Level 2, model history annotations were only permitted on the Model element. In SBML Level 3, they are permitted on all SBML components derived from SBase.

def libsbml.Model.getModifierSpeciesReference	(	self,
		args
	)

Get a ModifierSpeciesReference object based on its identifier.

getModifierSpeciesReference(string sid)   ModifierSpeciesReference

Parameters

sid	the identifier to search for.

Returns: the ModifierSpeciesReference in this Model with the identifier sid or None if no such ModifierSpeciesReference exists.

def libsbml.Model.getName ( self )

Returns the value of the 'name' attribute of this Model object.

getName()   string

: In SBML Level 3 Version 2, the 'id' and 'name' attributes were moved to SBase directly, instead of being defined individually for many (but not all) objects. LibSBML has for a long time provided functions defined on SBase itself to get, set, and unset those attributes, which would fail or otherwise return empty strings if executed on any object for which those attributes were not defined. Now that all SBase objects define those attributes, those functions now succeed for any object with the appropriate level and version.

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.

Regardless of the level and version of the SBML, these functions allow client applications to use more generalized code in some situations (for instance, when manipulating objects that are all known to have names). If the object in question does not posess a 'name' attribute according to the SBML specification for the Level and Version in use, libSBML will not allow the name to be set, nor will it read or write 'name' attributes for those objects.

Returns: the name of this SBML object, or the empty string if not set or unsettable.

See also: getIdAttribute(); isSetName(); setName(); unsetName()

def libsbml.SBase.getNamespaces ( self )

inherited

Returns a list of the XML Namespaces declared on the SBML document owning this object.

getNamespaces()   XMLNamespaces

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.

Returns: the XML Namespaces associated with this SBML object, or None in certain very usual circumstances where a namespace is not set.

See also: getLevel(); getVersion()

def libsbml.SBase.getNotes	(	self,
		args
	)

inherited

Returns the content of the 'notes' subelement of this object as a tree of XMLNode objects.

getNotes()   XMLNode

: The optional SBML element named 'notes', present on every major SBML component type (and in SBML Level 3, the 'message' subelement of Constraint), 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 conform to the definition of XHTML 1.0. However, the content cannot be entirely free-form; it must satisfy certain requirements defined in the SBML specifications for specific SBML Levels. To help verify the formatting of 'notes' content, libSBML provides the static utility method SyntaxChecker.hasExpectedXHTMLSyntax(); this method implements a verification process that lets callers check whether the content of a given XMLNode object conforms to the SBML requirements for 'notes' and 'message' structure. Developers are urged to consult the appropriate SBML specification document for the Level and Version of their model for more in-depth explanations of using 'notes' in SBML. 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().

Returns: the content of the 'notes' subelement of this SBML object as a tree structure composed of XMLNode objects.

See also: getNotesString(); isSetNotes(); setNotes(); setNotes(); appendNotes(); appendNotes(); unsetNotes(); SyntaxChecker.hasExpectedXHTMLSyntax()

def libsbml.SBase.getNotesString	(	self,
		args
	)

inherited

Returns the content of the 'notes' subelement of this object as a string.

getNotesString()   string

: The optional SBML element named 'notes', present on every major SBML component type (and in SBML Level 3, the 'message' subelement of Constraint), 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 conform to the definition of XHTML 1.0. However, the content cannot be entirely free-form; it must satisfy certain requirements defined in the SBML specifications for specific SBML Levels. To help verify the formatting of 'notes' content, libSBML provides the static utility method SyntaxChecker.hasExpectedXHTMLSyntax(); this method implements a verification process that lets callers check whether the content of a given XMLNode object conforms to the SBML requirements for 'notes' and 'message' structure. Developers are urged to consult the appropriate SBML specification document for the Level and Version of their model for more in-depth explanations of using 'notes' in SBML. 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.

Returns: the content of the 'notes' subelement of this SBML object as a string.

See also: getNotes(); isSetNotes(); setNotes(); setNotes(); appendNotes(); appendNotes(); unsetNotes(); SyntaxChecker.hasExpectedXHTMLSyntax()

def libsbml.Model.getNumCompartments ( self )

Get the number of Compartment objects in this Model.

getNumCompartments()   long

Returns: the number of Compartments in this Model.

def libsbml.Model.getNumCompartmentTypes ( self )

Get the number of CompartmentType objects in this Model.

getNumCompartmentTypes()   long

Returns: the number of CompartmentTypes in this Model.

Note: The CompartmentType object class is only available in SBML Level 2 Versions 2–4. It is not available in Level 1 nor Level 3.

def libsbml.Model.getNumConstraints ( self )

Get the number of Constraint objects in this Model.

getNumConstraints()   long

Returns: the number of Constraints in this Model.

def libsbml.SBase.getNumCVTerms ( self )

inherited

Returns the number of CVTerm objects in the annotations of this SBML object.

getNumCVTerms()   long

Returns: the number of CVTerms for this SBML object.

def libsbml.SBase.getNumDisabledPlugins ( self )

inherited

Returns the number of disabled plug-in objects (extension interfaces) for SBML Level 3 package extensions known.

getNumDisabledPlugins()   long

: SBML Level 3 consists of a Core definition that can be extended via optional SBML Level 3 packages. A given model may indicate that it uses one or more SBML packages, and likewise, a software tool may be able to support one or more packages. LibSBML does not come preconfigured with all possible packages included and enabled, in part because not all package specifications have been finalized. To support the ability for software systems to enable support for the Level 3 packages they choose, libSBML features a plug-in mechanism. Each SBML Level 3 package is implemented in a separate code plug-in that can be enabled by the application to support working with that SBML package. A given SBML model may thus contain not only objects defined by SBML Level 3 Core, but also objects created by libSBML plug-ins supporting additional Level 3 packages.

: If a plugin is disabled, the package information it contains is no longer considered to be part of the SBML document for the purposes of searching the document or writing out the document. However, the information is still retained, so if the plugin is enabled again, the same information will once again be available, and will be written out to the final model.

Returns: the number of disabled plug-in objects (extension interfaces) of package extensions known by this instance of libSBML.

def libsbml.Model.getNumEvents ( self )

Get the number of Event objects in this Model.

getNumEvents()   long

Returns: the number of Events in this Model.

def libsbml.Model.getNumFunctionDefinitions ( self )

Get the number of FunctionDefinition objects in this Model.

getNumFunctionDefinitions()   long

Returns: the number of FunctionDefinitions in this Model.

def libsbml.Model.getNumInitialAssignments ( self )

Get the number of InitialAssignment objects in this Model.

getNumInitialAssignments()   long

Returns: the number of InitialAssignments in this Model.

def libsbml.Model.getNumParameters ( self )

Get the number of Parameter objects in this Model.

getNumParameters()   long

Returns: the number of Parameters in this Model. Parameters defined in KineticLaws are not included.

def libsbml.SBase.getNumPlugins ( self )

inherited

Returns the number of plug-in objects (extenstion interfaces) for SBML Level 3 package extensions known.

getNumPlugins()   long

: SBML Level 3 consists of a Core definition that can be extended via optional SBML Level 3 packages. A given model may indicate that it uses one or more SBML packages, and likewise, a software tool may be able to support one or more packages. LibSBML does not come preconfigured with all possible packages included and enabled, in part because not all package specifications have been finalized. To support the ability for software systems to enable support for the Level 3 packages they choose, libSBML features a plug-in mechanism. Each SBML Level 3 package is implemented in a separate code plug-in that can be enabled by the application to support working with that SBML package. A given SBML model may thus contain not only objects defined by SBML Level 3 Core, but also objects created by libSBML plug-ins supporting additional Level 3 packages.

Returns: the number of plug-in objects (extension interfaces) of package extensions known by this instance of libSBML.

See also: getPlugin()

def libsbml.Model.getNumReactions ( self )

Get the number of Reaction objects in this Model.

getNumReactions()   long

Returns: the number of Reactions in this Model.

def libsbml.Model.getNumRules ( self )

Get the number of Rule objects in this Model.

getNumRules()   long

Returns: the number of Rules in this Model.

def libsbml.Model.getNumSpecies ( self )

Get the number of Species objects in this Model.

getNumSpecies()   long

Returns: the number of Species in this Model.

def libsbml.Model.getNumSpeciesTypes ( self )

Get the number of SpeciesType objects in this Model.

getNumSpeciesTypes()   long

Returns: the number of SpeciesTypes in this Model.

Note: The SpeciesType object class is only available in SBML Level 2 Versions 2–4. It is not available in Level 1 nor Level 3.

def libsbml.Model.getNumSpeciesWithBoundaryCondition ( self )

Get the number of Species in this Model having their 'boundaryCondition' attribute value set to True.

getNumSpeciesWithBoundaryCondition()   long

Returns: the number of Species in this Model with boundaryCondition set to true.

def libsbml.Model.getNumUnitDefinitions ( self )

Get the number of UnitDefinition objects in this Model.

getNumUnitDefinitions()   long

Returns: the number of UnitDefinitions in this Model.

def libsbml.SBase.getPackageCoreVersion ( self )

inherited

Returns the SBML Core Version within the SBML Level of the actual object.

getPackageCoreVersion()   long

: 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.)

Returns: the SBML core version of this SBML object.

def libsbml.SBase.getPackageName ( self )

inherited

Returns the name of the SBML Level 3 package in which this element is defined.

getPackageName()   string

Returns: the name of the SBML package in which this element is defined. The string "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.

def libsbml.SBase.getPackageVersion ( self )

inherited

Returns the Version of the SBML Level 3 package to which this element belongs to.

getPackageVersion()   long

Returns: the version of the SBML Level 3 package to which this element belongs. The value 0 will be returned if this element belongs to the SBML Level 3 Core package.

See also: getLevel(); getVersion()

def libsbml.Model.getParameter	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

getParameter(long  n)   Parameter
getParameter(string sid)   Parameter

Each variant is described separately below.

Method variant with the following signature:

getParameter(long n)

Get the nth Parameter object in this Model.

Parameters

n	the index of the object to return.

Returns: the nth Parameter of this Model. If the index n is invalid, None is returned.

Method variant with the following signature:

getParameter(string sid)

Get a Parameter object based on its identifier.

Parameters

sid	the identifier to search for.

Returns: the Parameter in this Model with the identifier sid or None if no such Parameter exists.

def libsbml.SBase.getParentSBMLObject	(	self,
		args
	)

inherited

Returns the parent SBML object containing this object.

getParentSBMLObject()   SBase

This returns the immediately-containing object. This method is convenient when holding an object nested inside other objects in an SBML model.

Returns: the parent SBML object of this SBML object.

See also: getSBMLDocument(); getModel()

def libsbml.SBase.getPlugin	(	self,
		args
	)

inherited

This method has multiple variants; they differ in the arguments they accept.

getPlugin(string package)   SBasePlugin
getPlugin(long  n)   SBasePlugin

Each variant is described separately below.

Method variant with the following signature:

getPlugin(long n)

Returns the nth plug-in object (extension interface) for an SBML Level 3 package extension. The returned plug-in will be the appropriate type of plugin requested: calling Model.getPlugin() will return an FbcModelPlugin; calling Parameter.getPlugin() will return CompSBasePlugin, etc.

If no such plugin exists, None is returned.

: SBML Level 3 consists of a Core definition that can be extended via optional SBML Level 3 packages. A given model may indicate that it uses one or more SBML packages, and likewise, a software tool may be able to support one or more packages. LibSBML does not come preconfigured with all possible packages included and enabled, in part because not all package specifications have been finalized. To support the ability for software systems to enable support for the Level 3 packages they choose, libSBML features a plug-in mechanism. Each SBML Level 3 package is implemented in a separate code plug-in that can be enabled by the application to support working with that SBML package. A given SBML model may thus contain not only objects defined by SBML Level 3 Core, but also objects created by libSBML plug-ins supporting additional Level 3 packages.

Parameters

n	the index of the plug-in to return.

Returns: the nth plug-in object (the libSBML extension interface) of a package extension. If the index n is invalid, None is returned.

See also: getNumPlugins(); getPlugin()

Method variant with the following signature:

getPlugin(string package)

Returns a plug-in object (extension interface) for an SBML Level 3 package extension with the given package name or URI. The returned plug-in will be the appropriate type of plugin requested: calling Model.getPlugin() will return an FbcModelPlugin; calling Parameter.getPlugin() will return CompSBasePlugin, etc.

If no such plugin exists, None is returned.

: SBML Level 3 consists of a Core definition that can be extended via optional SBML Level 3 packages. A given model may indicate that it uses one or more SBML packages, and likewise, a software tool may be able to support one or more packages. LibSBML does not come preconfigured with all possible packages included and enabled, in part because not all package specifications have been finalized. To support the ability for software systems to enable support for the Level 3 packages they choose, libSBML features a plug-in mechanism. Each SBML Level 3 package is implemented in a separate code plug-in that can be enabled by the application to support working with that SBML package. A given SBML model may thus contain not only objects defined by SBML Level 3 Core, but also objects created by libSBML plug-ins supporting additional Level 3 packages.

Parameters

package the name or URI of the package.

Returns: the plug-in object (the libSBML extension interface) of a package extension with the given package name or URI.

See also: getPlugin()

def libsbml.SBase.getPrefix ( self )

inherited

Returns the XML namespace prefix of this element.

getPrefix()   string

This reports the XML namespace prefix chosen for this class of object in the current SBML document. This may be an empty string if the component has no explicit prefix (for instance, if it is a core SBML object placed in the default SBML namespace of the document). If it is not empty, then it corresponds to the XML namespace prefix used set the object, whatever that may be in a given SBML document.

Returns: a text string representing the XML namespace prefix.

def libsbml.Model.getRateRule	(	self,
		args
	)

Get a Rule object based on the variable to which it assigns a value.

getRateRule(string variable)   RateRule

Parameters

variable the symbol to search for.

Returns: the Rule in this Model with the given 'variable' attribute value or None if no such Rule exists.

def libsbml.Model.getRateRuleByVariable	(	self,
		args
	)

Get a Rule object based on the variable to which it assigns a value.

getRateRuleByVariable(string variable)   RateRule

Parameters

variable the variable to search for.

Returns: the Rule in this Model with the given 'variable' attribute value or None if no such Rule exists.

def libsbml.Model.getReaction	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

getReaction(long  n)   Reaction
getReaction(string sid)   Reaction

Each variant is described separately below.

Method variant with the following signature:

getReaction(long n)

Get the nth Reaction object in this Model.

Parameters

n	the index of the object to return.

Returns: the nth Reaction of this Model. If the index n is invalid, None is returned.

Method variant with the following signature:

getReaction(string sid)

Get a Reaction object based on its identifier.

Parameters

sid	the identifier to search for.

Returns: the Reaction in this Model with the identifier sid or None if no such Reaction exists.

def libsbml.SBase.getResourceBiologicalQualifier	(	self,
		resource
	)

inherited

Returns the MIRIAM biological qualifier associated with the given resource.

getResourceBiologicalQualifier(string resource)   long

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 name begins with BQB_ from the interface class libsbml.

Parameters

resource string representing the resource; e.g., 'http://www.geneontology.org/#GO:0005892'.

Returns: the qualifier associated with the resource, or BQB_UNKNOWN if the resource does not exist.

Note: The set of MIRIAM biological qualifiers grows over time, although relatively slowly. The values are up to date with MIRIAM at the time of a given libSBML release. The set of values in list of BQB_ constants defined in libsbml may be expanded in later libSBML releases, to match the values defined by MIRIAM at that later time.

def libsbml.SBase.getResourceModelQualifier	(	self,
		resource
	)

inherited

Returns the MIRIAM model qualifier associated with the given resource.

getResourceModelQualifier(string resource)   long

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 BQM_ 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 name begins with BQM_ from the interface class libsbml.

Parameters

resource string representing the resource; e.g., 'http://www.geneontology.org/#GO:0005892'.

Returns: the model qualifier type associated with the resource, or BQM_UNKNOWN if the resource does not exist.

Note: The set of MIRIAM model qualifiers grows over time, although relatively slowly. The values are up to date with MIRIAM at the time of a given libSBML release. The set of values in list of BQM_ constants defined in libsbml may be expanded in later libSBML releases, to match the values defined by MIRIAM at that later time.

def libsbml.Model.getRule	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

getRule(long  n)   Rule
getRule(string variable)   Rule

Each variant is described separately below.

Method variant with the following signature:

getRule(string variable)

Get a Rule object based on the variable to which it assigns a value.

Parameters

variable the variable to search for.

Returns: the Rule in this Model with the given 'variable' attribute value or None if no such Rule exists.

Method variant with the following signature:

getRule(long n)

Get the nth Rule object in this Model.

Parameters

n	the index of the object to return.

Returns: the nth Rule of this Model. If the index n is invalid, None is returned.

def libsbml.Model.getRuleByVariable	(	self,
		args
	)

Get a Rule object based on the variable to which it assigns a value.

getRuleByVariable(string variable)   Rule

Parameters

variable the variable to search for.

Returns: the Rule in this Model with the given 'variable' attribute value or None if no such Rule exists.

def libsbml.SBase.getSBMLDocument	(	self,
		args
	)

inherited

Returns the SBMLDocument object containing this object instance.

getSBMLDocument()   SBMLDocument

: 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.

Returns: the parent SBMLDocument object of this SBML object.

See also: getParentSBMLObject(); getModel()

def libsbml.SBase.getSBOTerm ( self )

inherited

Returns the integer portion of the value of the 'sboTerm' attribute of this object.

getSBOTerm()   int

: Beginning with SBML Level 2 Version 2, 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'. More details can be found in SBML specifications for Level 2 Version 2 and above.

Returns: the value of the 'sboTerm' attribute as an integer, or -1 if the value is not set.

def libsbml.SBase.getSBOTermAsURL ( self )

inherited

Returns the URL representation of the 'sboTerm' attribute of this object.

getSBOTermAsURL()   string

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'. More details can be found in SBML specifications for Level 2 Version 2 and above.

Returns: the value of the 'sboTerm' attribute as an identifiers.org URL, or an empty string if the value is not set.

def libsbml.SBase.getSBOTermID ( self )

inherited

Returns the string representation of the 'sboTerm' attribute of this object.

getSBOTermID()   string

: Beginning with SBML Level 2 Version 2, 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'. More details can be found in SBML specifications for Level 2 Version 2 and above.

Returns: the value of the 'sboTerm' attribute as a string (its value will be of the form 'SBO:NNNNNNN'), or an empty string if the value is not set.

def libsbml.Model.getSpecies	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

getSpecies(long  n)   Species
getSpecies(string sid)   Species

Each variant is described separately below.

Method variant with the following signature:

getSpecies(long n)

Get the nth Species object in this Model.

Parameters

n	the index of the object to return.

Returns: the nth Species of this Model. If the index n is invalid, None is returned.

Method variant with the following signature:

getSpecies(string sid)

Get a Species object based on its identifier.

Parameters

sid	the identifier to search for.

Returns: the Species in this Model with the identifier sid or None if no such Species exists.

def libsbml.Model.getSpeciesReference	(	self,
		args
	)

Get a SpeciesReference object based on its identifier.

getSpeciesReference(string sid)   SpeciesReference

Parameters

sid	the identifier to search for.

Returns: the SpeciesReference in this Model with the identifier sid or None if no such SpeciesReference exists.

def libsbml.Model.getSpeciesType	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

getSpeciesType(long  n)   SpeciesType
getSpeciesType(string sid)   SpeciesType

Each variant is described separately below.

Method variant with the following signature:

getSpeciesType(long n)

Get the nth SpeciesType object in this Model.

Parameters

n	the index of the object to return.

Returns: the nth SpeciesType of this Model. If the index n is invalid, None is returned.

Note: The SpeciesType object class is only available in SBML Level 2 Versions 2–4. It is not available in Level 1 nor Level 3.

Method variant with the following signature:

getSpeciesType(string sid)

Get a SpeciesType object based on its identifier.

Parameters

sid	the identifier to search for.

Returns: the SpeciesType in this Model with the identifier sid or None if no such SpeciesType exists.

Note: The SpeciesType object class is only available in SBML Level 2 Versions 2–4. It is not available in Level 1 nor Level 3.

def libsbml.Model.getSubstanceUnits ( self )

Returns the value of the 'substanceUnits' attribute of this Model.

getSubstanceUnits()   string

Returns: the substanceUnits of this Model.

Note: The 'substanceUnits' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

def libsbml.Model.getTimeUnits ( self )

Returns the value of the 'timeUnits' attribute of this Model.

getTimeUnits()   string

Returns: the timeUnits of this Model.

Note: The 'timeUnits' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

def libsbml.Model.getTypeCode ( self )

Returns the libSBML type code for this SBML object.

getTypeCode()   int

: LibSBML attaches an identifying code to every kind of SBML object. These are integer constants known as SBML type codes. The names of all the codes begin with the characters SBML_. In the Python language interface for libSBML, the type codes are defined as static integer constants in the interface class libsbml. Note that different Level 3 package plug-ins may use overlapping type codes; to identify the package to which a given object belongs, call the SBase.getPackageName() method on the object.

The exception to this is lists: all SBML-style list elements have the type SBML_LIST_OF, regardless of what package they are from.

Returns: the SBML type code for this object: SBML_MODEL (default).

Warning: The specific integer values of the possible type codes may be reused by different libSBML plug-ins for SBML Level 3. packages, To fully identify the correct code, it is necessary to invoke both getPackageName() and getTypeCode() (or ListOf.getItemTypeCode()).

See also: getElementName(); getPackageName()

def libsbml.Model.getUnitDefinition	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

getUnitDefinition(long  n)   UnitDefinition
getUnitDefinition(string sid)   UnitDefinition

Each variant is described separately below.

Method variant with the following signature:

getUnitDefinition(long n)

Get the nth UnitDefinition object in this Model.

Parameters

n	the index of the object to return.

Returns: the nth UnitDefinition of this Model. If the index n is invalid, None is returned.

Method variant with the following signature:

getUnitDefinition(string sid)

Get a UnitDefinition based on its identifier.

Parameters

sid	the identifier to search for.

Returns: the UnitDefinition in this Model with the identifier sid or None if no such UnitDefinition exists.

def libsbml.SBase.getURI ( self )

inherited

Gets the namespace URI to which this element belongs to.

getURI()   string

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'.

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 then look for the namespace associated with the element itself.

Returns: the URI of this element, as a text string.

See also: getSBMLDocument(); getPackageName()

def libsbml.SBase.getVersion ( self )

inherited

Returns the Version within the SBML Level of the SBMLDocument object containing this object.

getVersion()   long

: 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.)

Returns: the SBML version of this SBML object.

See also: getLevel(); getNamespaces()

def libsbml.Model.getVolumeUnits ( self )

Returns the value of the 'volumeUnits' attribute of this Model.

getVolumeUnits()   string

Returns: the volumeUnits of this Model.

Note: The 'volumeUnits' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

def libsbml.Model.hasRequiredElements ( self )

Predicate returning True if all the required elements for this Model object have been set.

hasRequiredElements()   bool

Returns: a boolean value indicating whether all the required elements for this object have been defined.

def libsbml.SBase.hasValidLevelVersionNamespaceCombination ( self )

inherited

Predicate returning true if this object's level/version and namespace values correspond to a valid SBML specification.

hasValidLevelVersionNamespaceCombination()   bool

The valid combinations of SBML Level, Version and Namespace as of this release of libSBML are the following:

Level 1 Version 2: http://www.sbml.org/sbml/level1
Level 2 Version 1: http://www.sbml.org/sbml/level2
Level 2 Version 2: http://www.sbml.org/sbml/level2/version2
Level 2 Version 3: http://www.sbml.org/sbml/level2/version3
Level 2 Version 4: http://www.sbml.org/sbml/level2/version4
Level 3 Version 1 Core: http://www.sbml.org/sbml/level3/version1/core

Returns: true if the level, version and namespace values of this SBML object correspond to a valid set of values, false otherwise.

def libsbml.SBase.isPackageEnabled	(	self,
		pkgName
	)

inherited

Predicate returning True if the given SBML Level 3 package is enabled with this object.

isPackageEnabled(string pkgName)   bool

The search ignores the package version.

Parameters

pkgName the name of the package.

Returns: True if the given package is enabled within this object, False otherwise.

See also: isPackageURIEnabled()

def libsbml.SBase.isPackageURIEnabled	(	self,
		pkgURI
	)

inherited

Predicate returning True if an SBML Level 3 package with the given URI is enabled with this object.

isPackageURIEnabled(string pkgURI)   bool

Parameters

pkgURI the URI of the package.

Returns: True if the given package is enabled within this object, False otherwise.

See also: isPackageEnabled()

def libsbml.SBase.isPkgEnabled	(	self,
		pkgName
	)

inherited

Predicate returning True if the given SBML Level 3 package is enabled with this object.

isPkgEnabled(string pkgName)   bool

The search ignores the package version.

Parameters

pkgName the name of the package.

Returns: True if the given package is enabled within this object, False otherwise.

See also: isPkgURIEnabled()

def libsbml.SBase.isPkgURIEnabled	(	self,
		pkgURI
	)

inherited

Predicate returning True if an SBML Level 3 package with the given URI is enabled with this object.

isPkgURIEnabled(string pkgURI)   bool

Parameters

pkgURI the URI of the package.

Returns: True if the given package is enabled within this object, False otherwise.

See also: isPkgEnabled()

def libsbml.Model.isPopulatedAllElementIdList ( self )

Predicate returning True if libSBML has a list of the ids of all components of this model.

isPopulatedAllElementIdList()   bool

Returns: True if the id list has already been populated, False otherwise.

def libsbml.Model.isPopulatedAllElementMetaIdList ( self )

Predicate returning True if libSBML has a list of the metaids of all components of this model.

isPopulatedAllElementMetaIdList()   bool

Returns: True if the metaid list has already been populated, False otherwise.

def libsbml.Model.isPopulatedListFormulaUnitsData ( self )

Predicate returning True if libSBML has derived units for the components of this model.

isPopulatedListFormulaUnitsData()   bool

LibSBML can infer the units of measurement associated with different elements of a model. When libSBML does that, it builds a complex internal structure during a resource-intensive operation. This is done automatically only when callers invoke validation (via SBMLDocument.checkConsistency()) and have not turned off the unit validation option.

Callers can force units to be recalculated by calling populateListFormulaUnitsData(). To avoid calling that method unnecessarily, calling programs may first want to invoke this method (isPopulatedListFormulaUnitsData()) to determine whether it is even necessary.

Returns: True if the units have already been computed, False otherwise.

def libsbml.SBase.isSetAnnotation ( self )

inherited

Predicate returning True if this object's 'annotation' subelement exists and has content.

isSetAnnotation()   bool

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.

Returns: True if a 'annotation' subelement exists, False otherwise.

See also: getAnnotation(); getAnnotationString(); setAnnotation(); setAnnotation(); appendAnnotation(); appendAnnotation(); unsetAnnotation()

def libsbml.Model.isSetAreaUnits ( self )

Predicate returning True if this Model's 'areaUnits' attribute is set.

isSetAreaUnits()   bool

Returns: True if the 'areaUnits' attribute of this Model is set, False otherwise.

Note: The 'areaUnits' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

def libsbml.Model.isSetConversionFactor ( self )

Predicate returning True if this Model's 'conversionFactor' attribute is set.

isSetConversionFactor()   bool

Returns: True if the 'conversionFactor' attribute of this Model is set, False otherwise.

Note: The 'conversionFactor' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

def libsbml.Model.isSetExtentUnits ( self )

Predicate returning True if this Model's 'extentUnits' attribute is set.

isSetExtentUnits()   bool

Returns: True if the 'extentUnits' attribute of this Model is set, False otherwise.

Note: The 'extentUnits' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

def libsbml.Model.isSetId ( self )

Predicate returning True if this Model's 'id' attribute is set.

isSetId()   bool

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 SId or a type derived from that, such as UnitSId, depending on the object in question. All data types are defined as follows:

letter ::= 'a'..'z','A'..'Z'
digit  ::= '0'..'9'
idChar ::= letter | digit | '_'
SId    ::= ( letter | '_' ) idChar*

The characters ( and ) are used for grouping, the character * 'zero or more times', and the character | indicates logical 'or'. The equality of SBML identifiers is determined by an exact character sequence match; i.e., comparisons must be performed in a case-sensitive manner. This applies to all uses of SId, SIdRef, and derived types.

Users need to be aware of some important API issues that are the result of the history of SBML and libSBML. Prior to SBML Level 3 Version 2, SBML defined 'id' and 'name' attributes on only a subset of SBML objects. To simplify the work of programmers, libSBML's API provided get, set, check, and unset on the SBase object class itself instead of on individual subobject classes. This made the get/set/etc. methods uniformly available on all objects in the libSBML API. LibSBML simply returned empty strings or otherwise did not act when the methods were applied to SBML objects that were not defined by the SBML specification to have 'id' or 'name' attributes. Additional complications arose with the rule and assignment objects: InitialAssignment, EventAssignment, AssignmentRule, and RateRule. In early versions of SBML, the rule object hierarchy was different, and in addition, then as now, they possess different attributes: 'variable' (for the rules and event assignments), 'symbol' (for initial assignments), or neither (for algebraic rules). Prior to SBML Level 3 Version 2, getId() would always return an empty string, and isSetId() would always return False for objects of these classes.

With the addition of 'id' and 'name' attributes on SBase in Level 3 Version 2, it became necessary to introduce a new way to interact with the attributes more consistently in libSBML to avoid breaking backward compatibility in the behavior of the original 'id' methods. For this reason, libSBML provides four functions (getIdAttribute(), setIdAttribute(), isSetIdAttribute(), and unsetIdAttribute()) that always act on the actual 'id' attribute inherited from SBase, regardless of the object's type. These new methods should be used instead of the older getId()/setId()/etc. methods unless the old behavior is somehow necessary. Regardless of the Level and Version of the SBML, these functions allow client applications to use more generalized code in some situations (for instance, when manipulating objects that are all known to have identifiers). If the object in question does not posess an 'id' attribute according to the SBML specification for the Level and Version in use, libSBML will not allow the identifier to be set, nor will it read or write 'id' attributes for those objects.

Returns: True if the 'id' attribute of this SBML object is set, False otherwise.

Note: Because of the inconsistent behavior of this function with respect to assignments and rules, it is recommended that callers use isSetIdAttribute() instead.

See also: getIdAttribute(); setIdAttribute(); unsetIdAttribute(); isSetIdAttribute()

def libsbml.SBase.isSetIdAttribute ( self )

inherited

Predicate returning True if this object's 'id' attribute is set.

isSetIdAttribute()   bool

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 SId or a type derived from that, such as UnitSId, depending on the object in question. All data types are defined as follows:

letter ::= 'a'..'z','A'..'Z'
digit  ::= '0'..'9'
idChar ::= letter | digit | '_'
SId    ::= ( letter | '_' ) idChar*

The characters ( and ) are used for grouping, the character * 'zero or more times', and the character | indicates logical 'or'. The equality of SBML identifiers is determined by an exact character sequence match; i.e., comparisons must be performed in a case-sensitive manner. This applies to all uses of SId, SIdRef, and derived types.

Users need to be aware of some important API issues that are the result of the history of SBML and libSBML. Prior to SBML Level 3 Version 2, SBML defined 'id' and 'name' attributes on only a subset of SBML objects. To simplify the work of programmers, libSBML's API provided get, set, check, and unset on the SBase object class itself instead of on individual subobject classes. This made the get/set/etc. methods uniformly available on all objects in the libSBML API. LibSBML simply returned empty strings or otherwise did not act when the methods were applied to SBML objects that were not defined by the SBML specification to have 'id' or 'name' attributes. Additional complications arose with the rule and assignment objects: InitialAssignment, EventAssignment, AssignmentRule, and RateRule. In early versions of SBML, the rule object hierarchy was different, and in addition, then as now, they possess different attributes: 'variable' (for the rules and event assignments), 'symbol' (for initial assignments), or neither (for algebraic rules). Prior to SBML Level 3 Version 2, getId() would always return an empty string, and isSetId() would always return False for objects of these classes.

With the addition of 'id' and 'name' attributes on SBase in Level 3 Version 2, it became necessary to introduce a new way to interact with the attributes more consistently in libSBML to avoid breaking backward compatibility in the behavior of the original 'id' methods. For this reason, libSBML provides four functions (getIdAttribute(), setIdAttribute(), isSetIdAttribute(), and unsetIdAttribute()) that always act on the actual 'id' attribute inherited from SBase, regardless of the object's type. These new methods should be used instead of the older getId()/setId()/etc. methods unless the old behavior is somehow necessary. Regardless of the Level and Version of the SBML, these functions allow client applications to use more generalized code in some situations (for instance, when manipulating objects that are all known to have identifiers). If the object in question does not posess an 'id' attribute according to the SBML specification for the Level and Version in use, libSBML will not allow the identifier to be set, nor will it read or write 'id' attributes for those objects.

Returns: True if the 'id' attribute of this SBML object is set, False otherwise.

See also: getIdAttribute(); setIdAttribute(); unsetIdAttribute()

def libsbml.Model.isSetLengthUnits ( self )

Predicate returning True if this Model's 'lengthUnits' attribute is set.

isSetLengthUnits()   bool

Returns: True if the 'lengthUnits' attribute of this Model is set, False otherwise.

Note: The 'lengthUnits' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

def libsbml.SBase.isSetMetaId ( self )

inherited

Predicate returning True if this object's 'metaid' attribute is set.

isSetMetaId()   bool

: 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. The latter point is important, because the uniqueness criterion applies across any attribute with type ID anywhere in the file, 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 the XML ID type. Although SBML itself specifies the use of XML ID only for the 'metaid' attribute, SBML-compatible applications 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. Finally, note that LibSBML does not provide an explicit XML ID data type; it uses ordinary character strings, which is easier for applications to support.

Returns: True if the 'metaid' attribute of this SBML object is set, False otherwise.

See also: getMetaId(); setMetaId()

def libsbml.SBase.isSetModelHistory ( self )

inherited

Predicate returning True if this object has a ModelHistory object attached to it.

isSetModelHistory()   bool

Returns: True if the ModelHistory of this object is set, False otherwise.

Note: In SBML Level 2, model history annotations were only permitted on the Model element. In SBML Level 3, they are permitted on all SBML components derived from SBase.

def libsbml.Model.isSetName ( self )

Predicate returning True if this Model's 'name' attribute is set.

isSetName()   bool

: In SBML Level 3 Version 2, the 'id' and 'name' attributes were moved to SBase directly, instead of being defined individually for many (but not all) objects. LibSBML has for a long time provided functions defined on SBase itself to get, set, and unset those attributes, which would fail or otherwise return empty strings if executed on any object for which those attributes were not defined. Now that all SBase objects define those attributes, those functions now succeed for any object with the appropriate level and version.

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.

Regardless of the level and version of the SBML, these functions allow client applications to use more generalized code in some situations (for instance, when manipulating objects that are all known to have names). If the object in question does not posess a 'name' attribute according to the SBML specification for the Level and Version in use, libSBML will not allow the name to be set, nor will it read or write 'name' attributes for those objects.

Returns: True if the 'name' attribute of this SBML object is set, False otherwise.

See also: getName(); setName(); unsetName()

def libsbml.SBase.isSetNotes ( self )

inherited

Predicate returning True if this object's 'notes' subelement exists and has content.

isSetNotes()   bool

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.

Returns: True if a 'notes' subelement exists, False otherwise.

See also: getNotes(); getNotesString(); setNotes(); setNotes(); appendNotes(); appendNotes(); unsetNotes(); SyntaxChecker.hasExpectedXHTMLSyntax()

def libsbml.SBase.isSetSBOTerm ( self )

inherited

Predicate returning True if this object's 'sboTerm' attribute is set.

isSetSBOTerm()   bool

Returns: True if the 'sboTerm' attribute of this SBML object is set, False otherwise.

def libsbml.Model.isSetSubstanceUnits ( self )

Predicate returning True if this Model's 'substanceUnits' attribute is set.

isSetSubstanceUnits()   bool

Returns: True if the 'substanceUnits' attribute of this Model is set, False otherwise.

Note: The 'substanceUnits' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

def libsbml.Model.isSetTimeUnits ( self )

Predicate returning True if this Model's 'timeUnits' attribute is set.

isSetTimeUnits()   bool

Returns: True if the 'timeUnits' attribute of this Model is set, False otherwise.

Note: The 'substanceUnits' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

def libsbml.SBase.isSetUserData ( self )

inherited

Predicate returning true or false depending on whether the user data of this element has been set.

isSetUserData()   bool

: The user data associated with an SBML object can be used by an application developer to attach custom information to that object in the model. In case of a deep copy, this data will passed as-is. The data attribute will never be interpreted by libSBML.

Returns: boolean, True if this object's user data has been set, False otherwise.

def libsbml.Model.isSetVolumeUnits ( self )

Predicate returning True if this Model's 'volumeUnits' attribute is set.

isSetVolumeUnits()   bool

Returns: True if the 'volumeUnits' attribute of this Model is set, False otherwise.

Note: The 'volumeUnits' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

def libsbml.SBase.matchesRequiredSBMLNamespacesForAddition	(	self,
		args
	)

inherited

Returns True if this object's set of XML namespaces are a subset of the given object's XML namespaces.

matchesRequiredSBMLNamespacesForAddition(SBase sb)   bool

: 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 libSBML's SBMLNamespaces facilities is to create an SBMLNamespaces object somewhere in a program once, then hand that object as needed to object constructors that accept SBMLNamespaces as arguments.

Parameters

sb	an object to compare with respect to namespaces.

Returns: boolean, True if this object's collection of namespaces is a subset of sb's, False otherwise.

def libsbml.SBase.matchesSBMLNamespaces	(	self,
		args
	)

inherited

Returns True if this object's set of XML namespaces are the same as the given object's XML namespaces.

matchesSBMLNamespaces(SBase sb)   bool

: 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 libSBML's SBMLNamespaces facilities is to create an SBMLNamespaces object somewhere in a program once, then hand that object as needed to object constructors that accept SBMLNamespaces as arguments.

Parameters

sb	an object to compare with respect to namespaces.

Returns: boolean, True if this object's collection of namespaces is the same as sb's, False otherwise.

def libsbml.Model.populateAllElementIdList ( self )

Populates the internal list of the identifiers of all elements within this Model object.

populateAllElementIdList()

This method tells libSBML to retrieve the identifiers of all elements of the enclosing Model object. The result is stored in an internal list of ids. Users can access the resulting data by calling the method getAllElementIdList().

Warning: Retrieving all elements within a model is a time-consuming operation. Callers may want to call isPopulatedAllElementIdList() to determine whether the id list may already have been populated.

See also: isPopulatedAllElementIdList()

def libsbml.Model.populateAllElementMetaIdList ( self )

Populates the internal list of the metaids of all elements within this Model object.

populateAllElementMetaIdList()

This method tells libSBML to retrieve the identifiers of all elements of the enclosing Model object. The result is stored in an internal list of metaids. Users can access the resulting data by calling the method getAllElementMetaIdList().

Warning: Retrieving all elements within a model is a time-consuming operation. Callers may want to call isPopulatedAllElementMetaIdList() to determine whether the metaid list may already have been populated.

See also: isPopulatedAllElementMetaIdList()

def libsbml.Model.populateListFormulaUnitsData ( self )

Populates the internal list of derived units for this Model object.

populateListFormulaUnitsData()

This method tells libSBML to (re)calculate all units for all components of the enclosing Model object. The result is stored in an internal list of unit data. Users can access the resulting data by calling the method SBase.getDerivedUnitDefinition() available on most objects. (The name 'formula units data' is drawn from the name of the internal objects libSBML uses to store the data; note that these internal objects are not exposed to callers, because callers can interact with the results using the ordinary SBML unit objects.)

This method is used by libSBML itself in the validator concerned with unit consistency. The unit consistency validator (like all other validators in libSBML) is invoked by using SBMLDocument.checkConsistency(), with the consistency checks for the category LIBSBML_CAT_UNITS_CONSISTENCY turned on. The method populateListFormulaUnitsData() does not need to be called prior to invoking the validator if unit consistency checking has not been turned off. This method is only provided for cases when callers have a special need to force the unit data to be recalculated. For instance, during construction of a model, a caller may want to interrogate libSBML's inferred units without invoking full-blown model validation; this is a scenario in which calling populateListFormulaUnitsData() may be useful.

Warning: Computing and inferring units is a time-consuming operation. Callers may want to call isPopulatedListFormulaUnitsData() to determine whether the units may already have been computed, to save themselves the need of invoking unit inference unnecessarily.

See also: isPopulatedListFormulaUnitsData()

def libsbml.Model.removeCompartment	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

removeCompartment(long  n)   Compartment
removeCompartment(string sid)   Compartment

Each variant is described separately below.

Method variant with the following signature:

removeCompartment(long n)

Removes the nth Compartment object from this Model object and returns a pointer to it.

The caller owns the returned object and is responsible for deleting it.

Parameters

n	the index of the Compartment object to remove.

Returns: the Compartment object removed, or None if the given index is out of range.

Method variant with the following signature:

removeCompartment(string sid)

Removes the Compartment object with the given identifier from this Model object and returns a pointer to it.

The caller owns the returned object and is responsible for deleting it.

Parameters

sid	the identifier of the Compartment object to remove.

Returns: the Compartment object removed, or None if no Compartment object with the identifier exists in this Model object.

def libsbml.Model.removeCompartmentType	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

removeCompartmentType(long  n)   CompartmentType
removeCompartmentType(string sid)   CompartmentType

Each variant is described separately below.

Method variant with the following signature:

removeCompartmentType(long n)

Removes the nth CompartmentType object from this Model object and returns a pointer to it.

The caller owns the returned object and is responsible for deleting it.

Parameters

n	the index of the CompartmentType object to remove.

Returns: the ComapartmentType object removed, or None if the given index is out of range.

Method variant with the following signature:

removeCompartmentType(string sid)

Removes the CompartmentType object with the given identifier from this Model object and returns a pointer to it.

The caller owns the returned object and is responsible for deleting it.

Parameters

sid	the identifier of the object to remove.

Returns: the CompartmentType object removed, or None if no CompartmentType object with the identifier exists in this Model object.

def libsbml.Model.removeConstraint	(	self,
		n
	)

Removes the nth Constraint object from this Model object and returns a pointer to it.

removeConstraint(long  n)   Constraint

The caller owns the returned object and is responsible for deleting it.

Parameters

n	the index of the Constraint object to remove.

Returns: the Constraint object removed, or None if the given index is out of range.

def libsbml.Model.removeEvent	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

removeEvent(long  n)   Event
removeEvent(string sid)   Event

Each variant is described separately below.

Method variant with the following signature:

removeEvent(long n)

Removes the nth Event object from this Model object and returns a pointer to it.

The caller owns the returned object and is responsible for deleting it.

Parameters

n	the index of the Event object to remove.

Returns: the Event object removed, or None if the given index is out of range.

Method variant with the following signature:

removeEvent(string sid)

Removes the Event object with the given identifier from this Model object and returns a pointer to it.

The caller owns the returned object and is responsible for deleting it.

Parameters

sid	the identifier of the Event object to remove.

Returns: the Event object removed, or None if no Event object with the identifier exists in this Model object.

def libsbml.Model.removeFromParentAndDelete ( self )

Remove this Model from its parent SBMLDocument object.

removeFromParentAndDelete()   int

This works by finding this Model's parent SBMLDocument and then calling setModel(None) on it, indirectly deleting itself. Overridden from the SBase function since the parent is not a ListOf.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

def libsbml.Model.removeFunctionDefinition	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

removeFunctionDefinition(long  n)   FunctionDefinition
removeFunctionDefinition(string sid)   FunctionDefinition

Each variant is described separately below.

Method variant with the following signature:

removeFunctionDefinition(long n)

Removes the nth FunctionDefinition object from this Model object and returns a pointer to it.

The caller owns the returned object and is responsible for deleting it.

Parameters

n	the index of the FunctionDefinition object to remove.

Returns: the FunctionDefinition object removed, or None if the given index is out of range.

Method variant with the following signature:

removeFunctionDefinition(string sid)

Removes the FunctionDefinition object with the given identifier from this Model object and returns a pointer to it.

The caller owns the returned object and is responsible for deleting it.

Parameters

sid	the identifier of the FunctionDefinition object to remove.

Returns: the FunctionDefinition object removed, or None if no FunctionDefinition object with the identifier exists in this Model object.

def libsbml.Model.removeInitialAssignment	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

removeInitialAssignment(long  n)   InitialAssignment
removeInitialAssignment(string symbol)   InitialAssignment

Each variant is described separately below.

Method variant with the following signature:

removeInitialAssignment(string symbol)

Removes the InitialAssignment object with the given 'symbol' attribute from this Model object and returns a pointer to it.

The caller owns the returned object and is responsible for deleting it.

Parameters

symbol the 'symbol' attribute of the InitialAssignment object to remove.

Returns: the InitialAssignment object removed, or None if no InitialAssignment object with the 'symbol' attribute exists in this Model object.

Method variant with the following signature:

removeInitialAssignment(long n)

Removes the nth InitialAssignment object from this Model object and returns a pointer to it.

The caller owns the returned object and is responsible for deleting it.

Parameters

n	the index of the InitialAssignment object to remove.

Returns: the InitialAssignment object removed, or None if the given index is out of range.

def libsbml.Model.removeParameter	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

removeParameter(long  n)   Parameter
removeParameter(string sid)   Parameter

Each variant is described separately below.

Method variant with the following signature:

removeParameter(long n)

Removes the nth Parameter object from this Model object and returns a pointer to it.

The caller owns the returned object and is responsible for deleting it.

Parameters

n	the index of the Parameter object to remove.

Returns: the Parameter object removed, or None if the given index is out of range.

Method variant with the following signature:

removeParameter(string sid)

Removes the Parameter object with the given identifier from this Model object and returns a pointer to it.

The caller owns the returned object and is responsible for deleting it.

Parameters

sid	the identifier of the Parameter object to remove.

Returns: the Parameter object removed, or None if no Parameter object with the identifier exists in this Model object.

def libsbml.Model.removeReaction	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

removeReaction(long  n)   Reaction
removeReaction(string sid)   Reaction

Each variant is described separately below.

Method variant with the following signature:

removeReaction(long n)

Removes the nth Reaction object from this Model object and returns a pointer to it.

The caller owns the returned object and is responsible for deleting it.

Parameters

n	the index of the Reaction object to remove.

Returns: the Reaction object removed, or None if the given index is out of range.

Method variant with the following signature:

removeReaction(string sid)

Removes the Reaction object with the given identifier from this Model object and returns a pointer to it.

The caller owns the returned object and is responsible for deleting it.

Parameters

sid	the identifier of the Reaction object to remove.

Returns: the Reaction object removed, or None if no Reaction object with the identifier exists in this Model object.

def libsbml.Model.removeRule	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

removeRule(long  n)   Rule
removeRule(string variable)   Rule

Each variant is described separately below.

Method variant with the following signature:

removeRule(string variable)

Removes the Rule object with the given 'variable' attribute from this Model object and returns a pointer to it.

The caller owns the returned object and is responsible for deleting it.

Parameters

variable the 'variable' attribute of the Rule object to remove.

Returns: the Rule object removed, or None if no Rule object with the 'variable' attribute exists in this Model object.

Method variant with the following signature:

removeRule(long n)

Removes the nth Rule object from this Model object and returns a pointer to it.

The caller owns the returned object and is responsible for deleting it.

Parameters

n	the index of the Rule object to remove.

Returns: the Rule object removed, or None if the given index is out of range.

def libsbml.Model.removeRuleByVariable	(	self,
		variable
	)

Removes the Rule object with the given 'variable' attribute from this Model object and returns a pointer to it.

removeRuleByVariable(string variable)   Rule

The caller owns the returned object and is responsible for deleting it.

Parameters

variable the 'variable' attribute of the Rule object to remove.

Returns: the Rule object removed, or None if no Rule object with the 'variable' attribute exists in this Model object.

def libsbml.Model.removeSpecies	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

removeSpecies(long  n)   Species
removeSpecies(string sid)   Species

Each variant is described separately below.

Method variant with the following signature:

removeSpecies(long n)

Removes the nth Species object from this Model object and returns a pointer to it.

The caller owns the returned object and is responsible for deleting it.

Parameters

n	the index of the Species object to remove.

Returns: the Species object removed, or None if the given index is out of range.

Method variant with the following signature:

removeSpecies(string sid)

Removes the Species object with the given identifier from this Model object and returns a pointer to it.

The caller owns the returned object and is responsible for deleting it.

Parameters

sid	the identifier of the Species object to remove.

Returns: the Species object removed, or None if no Species object with the identifier exists in this Model object.

def libsbml.Model.removeSpeciesType	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

removeSpeciesType(long  n)   SpeciesType
removeSpeciesType(string sid)   SpeciesType

Each variant is described separately below.

Method variant with the following signature:

removeSpeciesType(long n)

Removes the nth SpeciesType object from this Model object and returns a pointer to it.

The caller owns the returned object and is responsible for deleting it.

Parameters

n	the index of the SpeciesType object to remove.

Returns: the SpeciesType object removed, or None if the given index is out of range.

Method variant with the following signature:

removeSpeciesType(string sid)

Removes the SpeciesType object with the given identifier from this Model object and returns a pointer to it.

The caller owns the returned object and is responsible for deleting it.

Parameters

sid	the identifier of the SpeciesType object to remove.

Returns: the SpeciesType object removed, or None if no SpeciesType object with the identifier exists in this Model object.

def libsbml.SBase.removeTopLevelAnnotationElement	(	self,
		args
	)

inherited

Removes the top-level element within the 'annotation' subelement of this SBML object with the given name and optional URI.

removeTopLevelAnnotationElement(string elementName, string elementURI, bool removeEmpty)   int
removeTopLevelAnnotationElement(string elementName, string elementURI)   int
removeTopLevelAnnotationElement(string elementName)   int

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.

Parameters

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.
removeEmpty	if after removing of the element, the annotation is empty, and the removeEmpty argument is true, the annotation node will be deleted (default).

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

See also: replaceTopLevelAnnotationElement(); replaceTopLevelAnnotationElement()

Note: Owing to the way that language interfaces are created in libSBML, this documentation may show methods that define default values for parameters with text that has the form parameter = value. This is not to be intepreted as a Python keyword argument; the use of a parameter name followed by an equals sign followed by a value is only meant to indicate a default value if the argument is not provided at all. It is not a keyword in the Python sense.

def libsbml.Model.removeUnitDefinition	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

removeUnitDefinition(long  n)   UnitDefinition
removeUnitDefinition(string sid)   UnitDefinition

Each variant is described separately below.

Method variant with the following signature:

removeUnitDefinition(long n)

Removes the nth UnitDefinition object from this Model object and returns a pointer to it.

The caller owns the returned object and is responsible for deleting it.

Parameters

n	the index of the UnitDefinition object to remove.

Returns: the UnitDefinition object removed., or None if the given index is out of range.

Method variant with the following signature:

removeUnitDefinition(string sid)

Removes the UnitDefinition object with the given identifier from this Model object and returns a pointer to it.

The caller owns the returned object and is responsible for deleting it.

Parameters

sid	the identifier of the UnitDefinition object to remove.

Returns: the UnitDefinition object removed, or None if no UnitDefinition object with the identifier exists in this Model object.

def libsbml.SBase.renameMetaIdRefs	(	self,
		oldid,
		newid
	)

inherited

Replaces all uses of a given meta identifier attribute value with another value.

renameMetaIdRefs(string oldid, string newid)

: In SBML, object 'meta' identifiers are of the XML data type ID; the SBML object attribute itself is typically named metaid. All attributes that hold values referring to values of type ID are of the XML data type IDREF. They are also sometimes informally referred to as 'metaid refs', in analogy to the SBML-defined type SIdRef.

This method works by looking at all meta-identifier 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.

Parameters

oldid	the old identifier.
newid	the new identifier.

def libsbml.Model.renameSIdRefs	(	self,
		oldid,
		newid
	)

Replaces all uses of a given SIdRef type attribute value with another value.

renameSIdRefs(string oldid, string newid)

: In SBML, object identifiers are of a data type called SId. In SBML Level 3, an explicit data type called SIdRef was introduced for attribute values that refer to SId values; in previous Levels of SBML, this data type did not exist and attributes were simply described to as 'referring to an identifier', but the effective data type was the same as SIdRef in Level 3. These and other methods of libSBML refer to the type SIdRef for all Levels of SBML, even if the corresponding SBML specification did not explicitly name the data type.

This method works by looking at all attributes and (if appropriate) mathematical formulas in MathML content, comparing the referenced identifiers to the value of oldid. If any matches are found, the matching values are replaced with newid. The method does not descend into child elements.

Parameters

oldid	the old identifier.
newid	the new identifier.

def libsbml.Model.renameUnitSIdRefs	(	self,
		oldid,
		newid
	)

Replaces all uses of a given UnitSIdRef type attribute value with another value.

renameUnitSIdRefs(string oldid, string newid)

: In SBML, unit definitions have identifiers of type UnitSId. In SBML Level 3, an explicit data type called UnitSIdRef was introduced for attribute values that refer to UnitSId values; in previous Levels of SBML, this data type did not exist and attributes were simply described to as 'referring to a unit identifier', but the effective data type was the same as UnitSIdRef in Level 3. These and other methods of libSBML refer to the type UnitSIdRef for all Levels of SBML, even if the corresponding SBML specification did not explicitly name the data type.

This method works by looking at all unit identifier attribute values (including, if appropriate, inside mathematical formulas), comparing the referenced unit identifiers to the value of oldid. If any matches are found, the matching values are replaced with newid. The method does not descend into child elements.

Parameters

oldid	the old identifier.
newid	the new identifier.

def libsbml.SBase.replaceTopLevelAnnotationElement	(	self,
		args
	)

inherited

This method has multiple variants; they differ in the arguments they accept.

replaceTopLevelAnnotationElement(XMLNode annotation)   int
replaceTopLevelAnnotationElement(string annotation)   int

Each variant is described separately below.

Method variant with the following signature:

replaceTopLevelAnnotationElement(XMLNode annotation)

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) followed by calling appendAnnotation(annotation_with_name), with the exception that the placement of the annotation element remains the same.

Parameters

annotation XMLNode representing the replacement top level annotation.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

See also: removeTopLevelAnnotationElement(); replaceTopLevelAnnotationElement()

Method variant with the following signature:

replaceTopLevelAnnotationElement(string annotation)

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) followed by calling appendAnnotation(annotation_with_name), with the exception that the placement of the annotation element remains the same.

Parameters

annotation string representing the replacement top level annotation.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

See also: removeTopLevelAnnotationElement(); replaceTopLevelAnnotationElement()

def libsbml.Model.setAnnotation	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

setAnnotation(XMLNode annotation)   int
setAnnotation(string annotation)   int

Each variant is described separately below.

Method variant with the following signature:

setAnnotation(XMLNode annotation)

Sets the value of the 'annotation' subelement of this SBML object to a copy of annotation.

Any existing content of the 'annotation' subelement is 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 appendAnnotation().

Parameters

annotation an XML structure that is to be used as the content of the 'annotation' subelement of this object.

Returns

integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:

LIBSBML_OPERATION_SUCCESS

See also: appendAnnotation()

Method variant with the following signature:

setAnnotation(string annotation)

Sets the value of the 'annotation' subelement of this SBML object to a copy of annotation.

Any existing content of the 'annotation' subelement is 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 appendAnnotation().

Parameters

annotation an XML string that is to be used as the content of the 'annotation' subelement of this object.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

See also: appendAnnotation()

def libsbml.Model.setAreaUnits	(	self,
		units
	)

Sets the value of the 'areaUnits' attribute of this Model.

setAreaUnits(string units)   int

The string in units is copied.

Parameters

units the new areaUnits for the Model.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: The 'areaUnits' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

def libsbml.Model.setConversionFactor	(	self,
		units
	)

Sets the value of the 'conversionFactor' attribute of this Model.

setConversionFactor(string units)   int

The string in units is copied.

Parameters

units the new conversionFactor for the Model.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: The 'conversionFactor' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

def libsbml.Model.setExtentUnits	(	self,
		units
	)

Sets the value of the 'extentUnits' attribute of this Model.

setExtentUnits(string units)   int

The string in units is copied.

Parameters

units the new extentUnits for the Model.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: The 'extentUnits' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

def libsbml.Model.setId	(	self,
		sid
	)

Sets the value of the 'id' attribute of this Model.

setId(string sid)   int

: The string sid is copied.

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 SId or a type derived from that, such as UnitSId, depending on the object in question. All data types are defined as follows:

letter ::= 'a'..'z','A'..'Z'
digit  ::= '0'..'9'
idChar ::= letter | digit | '_'
SId    ::= ( letter | '_' ) idChar*

The characters ( and ) are used for grouping, the character * 'zero or more times', and the character | indicates logical 'or'. The equality of SBML identifiers is determined by an exact character sequence match; i.e., comparisons must be performed in a case-sensitive manner. This applies to all uses of SId, SIdRef, and derived types.

Users need to be aware of some important API issues that are the result of the history of SBML and libSBML. Prior to SBML Level 3 Version 2, SBML defined 'id' and 'name' attributes on only a subset of SBML objects. To simplify the work of programmers, libSBML's API provided get, set, check, and unset on the SBase object class itself instead of on individual subobject classes. This made the get/set/etc. methods uniformly available on all objects in the libSBML API. LibSBML simply returned empty strings or otherwise did not act when the methods were applied to SBML objects that were not defined by the SBML specification to have 'id' or 'name' attributes. Additional complications arose with the rule and assignment objects: InitialAssignment, EventAssignment, AssignmentRule, and RateRule. In early versions of SBML, the rule object hierarchy was different, and in addition, then as now, they possess different attributes: 'variable' (for the rules and event assignments), 'symbol' (for initial assignments), or neither (for algebraic rules). Prior to SBML Level 3 Version 2, getId() would always return an empty string, and isSetId() would always return False for objects of these classes.

With the addition of 'id' and 'name' attributes on SBase in Level 3 Version 2, it became necessary to introduce a new way to interact with the attributes more consistently in libSBML to avoid breaking backward compatibility in the behavior of the original 'id' methods. For this reason, libSBML provides four functions (getIdAttribute(), setIdAttribute(), isSetIdAttribute(), and unsetIdAttribute()) that always act on the actual 'id' attribute inherited from SBase, regardless of the object's type. These new methods should be used instead of the older getId()/setId()/etc. methods unless the old behavior is somehow necessary. Regardless of the Level and Version of the SBML, these functions allow client applications to use more generalized code in some situations (for instance, when manipulating objects that are all known to have identifiers). If the object in question does not posess an 'id' attribute according to the SBML specification for the Level and Version in use, libSBML will not allow the identifier to be set, nor will it read or write 'id' attributes for those objects.

Parameters

sid	the string to use as the identifier of this object.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

See also: getIdAttribute(); setIdAttribute(); isSetIdAttribute(); unsetIdAttribute()

def libsbml.SBase.setIdAttribute	(	self,
		sid
	)

inherited

Sets the value of the 'id' attribute of this SBML object.

setIdAttribute(string sid)   int

: The string sid is copied.

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 SId or a type derived from that, such as UnitSId, depending on the object in question. All data types are defined as follows:

letter ::= 'a'..'z','A'..'Z'
digit  ::= '0'..'9'
idChar ::= letter | digit | '_'
SId    ::= ( letter | '_' ) idChar*

The characters ( and ) are used for grouping, the character * 'zero or more times', and the character | indicates logical 'or'. The equality of SBML identifiers is determined by an exact character sequence match; i.e., comparisons must be performed in a case-sensitive manner. This applies to all uses of SId, SIdRef, and derived types.

Users need to be aware of some important API issues that are the result of the history of SBML and libSBML. Prior to SBML Level 3 Version 2, SBML defined 'id' and 'name' attributes on only a subset of SBML objects. To simplify the work of programmers, libSBML's API provided get, set, check, and unset on the SBase object class itself instead of on individual subobject classes. This made the get/set/etc. methods uniformly available on all objects in the libSBML API. LibSBML simply returned empty strings or otherwise did not act when the methods were applied to SBML objects that were not defined by the SBML specification to have 'id' or 'name' attributes. Additional complications arose with the rule and assignment objects: InitialAssignment, EventAssignment, AssignmentRule, and RateRule. In early versions of SBML, the rule object hierarchy was different, and in addition, then as now, they possess different attributes: 'variable' (for the rules and event assignments), 'symbol' (for initial assignments), or neither (for algebraic rules). Prior to SBML Level 3 Version 2, getId() would always return an empty string, and isSetId() would always return False for objects of these classes.

With the addition of 'id' and 'name' attributes on SBase in Level 3 Version 2, it became necessary to introduce a new way to interact with the attributes more consistently in libSBML to avoid breaking backward compatibility in the behavior of the original 'id' methods. For this reason, libSBML provides four functions (getIdAttribute(), setIdAttribute(), isSetIdAttribute(), and unsetIdAttribute()) that always act on the actual 'id' attribute inherited from SBase, regardless of the object's type. These new methods should be used instead of the older getId()/setId()/etc. methods unless the old behavior is somehow necessary. Regardless of the Level and Version of the SBML, these functions allow client applications to use more generalized code in some situations (for instance, when manipulating objects that are all known to have identifiers). If the object in question does not posess an 'id' attribute according to the SBML specification for the Level and Version in use, libSBML will not allow the identifier to be set, nor will it read or write 'id' attributes for those objects.

Parameters

sid	the string to use as the identifier of this object.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

See also: getIdAttribute(); setIdAttribute(); isSetIdAttribute(); unsetIdAttribute()

def libsbml.Model.setLengthUnits	(	self,
		units
	)

Sets the value of the 'lengthUnits' attribute of this Model.

setLengthUnits(string units)   int

The string in units is copied.

Parameters

units the new lengthUnits for the Model.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: The 'lengthUnits' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

def libsbml.SBase.setMetaId	(	self,
		metaid
	)

inherited

Sets the value of the meta-identifier attribute of this SBML object.

setMetaId(string metaid)   int

: 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. The latter point is important, because the uniqueness criterion applies across any attribute with type ID anywhere in the file, 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 the XML ID type. Although SBML itself specifies the use of XML ID only for the 'metaid' attribute, SBML-compatible applications 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. Finally, note that LibSBML does not provide an explicit XML ID data type; it uses ordinary character strings, which is easier for applications to support.

The string metaid is copied.

Parameters

metaid the identifier string to use as the value of the 'metaid' attribute.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

See also: getMetaId(); isSetMetaId()

def libsbml.SBase.setModelHistory	(	self,
		history
	)

inherited

Sets the ModelHistory of this object.

setModelHistory(ModelHistory history)   int

The content of history is copied, and this object's existing model history content is deleted.

Parameters

history ModelHistory of this object.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: In SBML Level 2, model history annotations were only permitted on the Model element. In SBML Level 3, they are permitted on all SBML components derived from SBase.

def libsbml.Model.setName	(	self,
		name
	)

Sets the value of the 'name' attribute of this Model.

setName(string name)   int

The string in name is copied.

Parameters

name	the new name for the SBML object.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

def libsbml.SBase.setNamespaces	(	self,
		xmlns
	)

inherited

Sets the namespaces relevant of this SBML object.

setNamespaces(XMLNamespaces xmlns)   int

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.

Parameters

xmlns the namespaces to set.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

LIBSBML_OPERATION_SUCCESS

def libsbml.SBase.setNotes	(	self,
		args
	)

inherited

This method has multiple variants; they differ in the arguments they accept.

setNotes(XMLNode notes)   int
setNotes(string notes, bool addXHTMLMarkup)   int
setNotes(string notes)   int

Each variant is described separately below.

Method variant with the following signature:

setNotes(string notes, bool addXHTMLMarkup = false)

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.

 try:
   sbmlDoc = SBMLDocument(3, 1)
 except ValueError:
   print('Could not create SBMLDocument object')
   sys.exit(1)
 
 note = '<body xmlns='http://www.w3.org/1999/xhtml'><p>here is my note</p></body>'
 
 status = sbmlDoc.setNotes(note)
 if status != LIBSBML_OPERATION_SUCCESS:
   # Do something to handle the error here.
   print('Unable to set notes on the SBML document object')
   sys.exit(1)

Parameters

notes	an XML string that is to be used as the content of the 'notes' subelement of this object.
addXHTMLMarkup	a boolean 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.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

See also: getNotesString(); isSetNotes(); setNotes(); appendNotes(); appendNotes(); unsetNotes(); SyntaxChecker.hasExpectedXHTMLSyntax()

Note: Owing to the way that language interfaces are created in libSBML, this documentation may show methods that define default values for parameters with text that has the form parameter = value. This is not to be intepreted as a Python keyword argument; the use of a parameter name followed by an equals sign followed by a value is only meant to indicate a default value if the argument is not provided at all. It is not a keyword in the Python sense.

Method variant with the following signature:

setNotes(XMLNode notes)

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.

Parameters

notes an XML structure that is to be used as the content of the 'notes' subelement of this object.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

See also: getNotesString(); isSetNotes(); setNotes(); appendNotes(); appendNotes(); unsetNotes(); SyntaxChecker.hasExpectedXHTMLSyntax()

def libsbml.SBase.setSBOTerm	(	self,
		args
	)

inherited

This method has multiple variants; they differ in the arguments they accept.

setSBOTerm(int value)   int
setSBOTerm(string sboid)   int

Each variant is described separately below.

Method variant with the following signature:

setSBOTerm(int value)

Sets the value of the 'sboTerm' attribute.

: Beginning with SBML Level 2 Version 2, 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'. More details can be found in SBML specifications for Level 2 Version 2 and above.

Parameters

value the NNNNNNN integer portion of the SBO identifier.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

See also: setSBOTerm()

Method variant with the following signature:

setSBOTerm(string sboid)

Sets the value of the 'sboTerm' attribute by string.

: Beginning with SBML Level 2 Version 2, 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'. More details can be found in SBML specifications for Level 2 Version 2 and above.

Parameters

sboid the SBO identifier string of the form 'SBO:NNNNNNN'.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

See also: setSBOTerm()

def libsbml.Model.setSubstanceUnits	(	self,
		units
	)

Sets the value of the 'substanceUnits' attribute of this Model.

setSubstanceUnits(string units)   int

The string in units is copied.

Parameters

units the new substanceUnits for the Model.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: The 'substanceUnits' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

def libsbml.Model.setTimeUnits	(	self,
		units
	)

Sets the value of the 'timeUnits' attribute of this Model.

setTimeUnits(string units)   int

The string in units is copied.

Parameters

units the new timeUnits for the Model.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: The 'timeUnits' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

def libsbml.Model.setVolumeUnits	(	self,
		units
	)

Sets the value of the 'volumeUnits' attribute of this Model.

setVolumeUnits(string units)   int

The string in units is copied.

Parameters

units the new volumeUnits for the Model.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: The 'volumeUnits' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

def libsbml.SBase.toSBML ( self )

inherited

Returns a string consisting of a partial SBML corresponding to just this object.

toSBML()   string

Returns: the partial SBML that describes this SBML object.

Warning: This is primarily provided for testing and debugging purposes. It may be removed in a future version of libSBML.

def libsbml.SBase.toXMLNode ( self )

inherited

Returns this element as an XMLNode.

toXMLNode()   XMLNode

Returns: this element as an XMLNode.

Warning: This operation is computationally expensive, because the element has to be fully serialized to a string and then parsed into the XMLNode structure. Attempting to convert a large tree structure (e.g., a large Model) may consume significant computer memory and time.

def libsbml.SBase.unsetAnnotation ( self )

inherited

Unsets the value of the 'annotation' subelement of this SBML object.

unsetAnnotation()   int

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.

Returns

integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:

LIBSBML_OPERATION_SUCCESS

See also: getAnnotation(); getAnnotationString(); isSetAnnotation(); setAnnotation(); setAnnotation(); appendAnnotation(); appendAnnotation()

def libsbml.Model.unsetAreaUnits ( self )

Unsets the value of the 'areaUnits' attribute of this Model.

unsetAreaUnits()   int

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: The 'areaUnits' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

def libsbml.Model.unsetConversionFactor ( self )

Unsets the value of the 'conversionFactor' attribute of this Model.

unsetConversionFactor()   int

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: The 'conversionFactor' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

def libsbml.SBase.unsetCVTerms ( self )

inherited

Clears the list of CVTerm objects attached to this SBML object.

unsetCVTerms()   int

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

def libsbml.Model.unsetExtentUnits ( self )

Unsets the value of the 'extentUnits' attribute of this Model.

unsetExtentUnits()   int

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: The 'extentUnits' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

def libsbml.Model.unsetId ( self )

Unsets the value of the 'id' attribute of this Model.

unsetId()   int

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 SId or a type derived from that, such as UnitSId, depending on the object in question. All data types are defined as follows:

letter ::= 'a'..'z','A'..'Z'
digit  ::= '0'..'9'
idChar ::= letter | digit | '_'
SId    ::= ( letter | '_' ) idChar*

The characters ( and ) are used for grouping, the character * 'zero or more times', and the character | indicates logical 'or'. The equality of SBML identifiers is determined by an exact character sequence match; i.e., comparisons must be performed in a case-sensitive manner. This applies to all uses of SId, SIdRef, and derived types.

Users need to be aware of some important API issues that are the result of the history of SBML and libSBML. Prior to SBML Level 3 Version 2, SBML defined 'id' and 'name' attributes on only a subset of SBML objects. To simplify the work of programmers, libSBML's API provided get, set, check, and unset on the SBase object class itself instead of on individual subobject classes. This made the get/set/etc. methods uniformly available on all objects in the libSBML API. LibSBML simply returned empty strings or otherwise did not act when the methods were applied to SBML objects that were not defined by the SBML specification to have 'id' or 'name' attributes. Additional complications arose with the rule and assignment objects: InitialAssignment, EventAssignment, AssignmentRule, and RateRule. In early versions of SBML, the rule object hierarchy was different, and in addition, then as now, they possess different attributes: 'variable' (for the rules and event assignments), 'symbol' (for initial assignments), or neither (for algebraic rules). Prior to SBML Level 3 Version 2, getId() would always return an empty string, and isSetId() would always return False for objects of these classes.

With the addition of 'id' and 'name' attributes on SBase in Level 3 Version 2, it became necessary to introduce a new way to interact with the attributes more consistently in libSBML to avoid breaking backward compatibility in the behavior of the original 'id' methods. For this reason, libSBML provides four functions (getIdAttribute(), setIdAttribute(), isSetIdAttribute(), and unsetIdAttribute()) that always act on the actual 'id' attribute inherited from SBase, regardless of the object's type. These new methods should be used instead of the older getId()/setId()/etc. methods unless the old behavior is somehow necessary. Regardless of the Level and Version of the SBML, these functions allow client applications to use more generalized code in some situations (for instance, when manipulating objects that are all known to have identifiers). If the object in question does not posess an 'id' attribute according to the SBML specification for the Level and Version in use, libSBML will not allow the identifier to be set, nor will it read or write 'id' attributes for those objects.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

See also: getIdAttribute(); setIdAttribute(); isSetIdAttribute(); unsetIdAttribute()

def libsbml.SBase.unsetIdAttribute ( self )

inherited

Unsets the value of the 'id' attribute of this SBML object.

unsetIdAttribute()   int

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.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

See also: getIdAttribute(); setIdAttribute(); isSetIdAttribute()

def libsbml.Model.unsetLengthUnits ( self )

Unsets the value of the 'lengthUnits' attribute of this Model.

unsetLengthUnits()   int

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: The 'lengthUnits' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

def libsbml.SBase.unsetMetaId ( self )

inherited

Unsets the value of the 'metaid' attribute of this SBML object.

unsetMetaId()   int

: 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. The latter point is important, because the uniqueness criterion applies across any attribute with type ID anywhere in the file, 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 the XML ID type. Although SBML itself specifies the use of XML ID only for the 'metaid' attribute, SBML-compatible applications 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. Finally, note that LibSBML does not provide an explicit XML ID data type; it uses ordinary character strings, which is easier for applications to support.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

def libsbml.SBase.unsetModelHistory ( self )

inherited

Unsets the ModelHistory object attached to this object.

unsetModelHistory()   int

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: In SBML Level 2, model history annotations were only permitted on the Model element. In SBML Level 3, they are permitted on all SBML components derived from SBase.

def libsbml.Model.unsetName ( self )

Unsets the value of the 'name' attribute of this Model.

unsetName()   int

: In SBML Level 3 Version 2, the 'id' and 'name' attributes were moved to SBase directly, instead of being defined individually for many (but not all) objects. LibSBML has for a long time provided functions defined on SBase itself to get, set, and unset those attributes, which would fail or otherwise return empty strings if executed on any object for which those attributes were not defined. Now that all SBase objects define those attributes, those functions now succeed for any object with the appropriate level and version.

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.

Regardless of the level and version of the SBML, these functions allow client applications to use more generalized code in some situations (for instance, when manipulating objects that are all known to have names). If the object in question does not posess a 'name' attribute according to the SBML specification for the Level and Version in use, libSBML will not allow the name to be set, nor will it read or write 'name' attributes for those objects.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

See also: getName(); setName(); isSetName()

def libsbml.SBase.unsetNotes ( self )

inherited

Unsets the value of the 'notes' subelement of this SBML object.

unsetNotes()   int

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.

Returns

integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:

LIBSBML_OPERATION_SUCCESS

See also: getNotesString(); isSetNotes(); setNotes(); setNotes(); appendNotes(); appendNotes(); SyntaxChecker.hasExpectedXHTMLSyntax()

def libsbml.SBase.unsetSBOTerm ( self )

inherited

Unsets the value of the 'sboTerm' attribute of this SBML object.

unsetSBOTerm()   int

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

def libsbml.Model.unsetSubstanceUnits ( self )

Unsets the value of the 'substanceUnits' attribute of this Model.

unsetSubstanceUnits()   int

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: The 'substanceUnits' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

def libsbml.Model.unsetTimeUnits ( self )

Unsets the value of the 'timeUnits' attribute of this Model.

unsetTimeUnits()   int

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: The 'timeUnits' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

def libsbml.SBase.unsetUserData ( self )

inherited

Unsets the user data of this element.

unsetUserData()   int

: The user data associated with an SBML object can be used by an application developer to attach custom information to that object in the model. In case of a deep copy, this data will passed as-is. The data attribute will never be interpreted by libSBML.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

def libsbml.Model.unsetVolumeUnits ( self )

Unsets the value of the 'volumeUnits' attribute of this Model.

unsetVolumeUnits()   int

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: The 'volumeUnits' attribute is available in SBML Level 3 but is not present on Model in lower Levels of SBML.

Detailed Description

Approaches to creating objects using the libSBML API

Consistency and adherence to SBML specifications

Model attributes introduced in SBML Level 3

The 'substanceUnits' attribute

The 'timeUnits' attribute

The 'volumeUnits', 'areaUnits', and 'lengthUnits' attributes

The 'extentUnits' attribute

The 'conversionFactor' attribute

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation