MathSBML

MathSBML Home Page MathSBML Site Map

Model Builder: getObject


These functions return one or more symbolic SBML objects indexed by number or name. Here object is a string representing an SBML object such as "species" or "event"; attribute is a string representing a particular attribute of that object such as "id" or "size".

getObject[ object, integer | {object, integer (, object, integer )* } ]
getObjectAttribute[ object, attribute, integer ] returns the value of a single attribute for object, e.g., getObjectAttribute["species", "id", 4].
getObjectID[ object, integer ] returns the value of the id field of the nth object, e.g., getObjectID["species", 5].
getObjectIDs[ object ] returns a list with the IDs of all the specified objects, e.g, getObjectIDs["compartment"]
getObjectName[ object, integer ]returns the value of the name field of the nth object, e.g., getObjectName["event", 4]
getObjectNames[ object] returns a list with the names of all the specified objects, e.g, getObjectNames["compartment"]
getObjects[ object] returns a list with all the specified objects, e.g, getObjects["compartment"]

Versions for specific objects

getCompartment[ integer | SId | { integer | SId (, integer | SId)* } ]
getCompartmentType[ integer | SId | { integer | SId (, integer | SId)* } ]
getConstraint[ integer | SId | { integer | SId (, integer | SId)* } ]
getEvent[ integer | SId | { integer | SId (, integer | SId)* } ]
getFunction[ integer | SId | { integer | SId (, integer | SId)* } ]
getInitialAssignment[ integer | SId | { integer | SId (, integer | SId)* } ]
getParameter[ integer | SId | { integer | SId (, integer | SId)* } ]
getReaction[ integer | SId | { integer | SId (, integer | SId)* } ]
getRule[ integer | { integer (, integer )* } ]
getSpecies[ integer | SId | { integer | SId (, integer | SId)* } ]
getSpeciesType[ integer | SId | { integer | SId (, integer | SId)* } ]
getUnit[ integer | SId | { integer | SId (, integer | SId)* } ]

Get the number of a specific type of object

getNumberOfObjects[ object ]

getNumberOfCompartments[], getNumberOfSpecies[], ...

These functions retrieve all of a given type of object as a list of symbolic sbml objects:

getCompartments[],getEvents[], ...

getCompartmentID[i], getSpeciesID[i],...

getCompartmentIDs[], getSpeciesIDs[], ...

getCompartmentName[i], getSpeciesName[i],...

getCompartmentNames[], getSpeciesNames[], ...

getModel[] - returns the current SBML Model as symbolic SBML; it is identical to createSymbolicModel[];
getSBMLModel[] - returns the current SBML as text SBML; it is identical to createModel[];


New in 2.4.7. Revised in 2.6.6
[08-10-07]