Computational Systems Biology
Sauro Lab
University of Washington
Home  |   Downloads  |   News  |   Research  |   Papers  |   About Us  |   Contact Us  |   SBW Help   |   Jobs
     


What is SBW 
Research Impact 
Published Papers 
Lab Members 
Available Positions 
CSB Links 
Courses 
 
 
 
Software Downloads:

1. SBW
2. JDesigner
3. Jarnac
4. WinSCAMP
5. Matlab Interface
6. Optimization
6. Bifurcation
 
maintained by Frank Bergmann
 
 
 
 

SBML Support Module API

Service: NOM

double getValue(string)

Gets the value assigned to the input string. The input string can be a species name/Id, parameter name/Id, compartment name/Id.

boolean exists(string)

The returns 1 if the input string appears in the sbml document otherwise 0. The input string can be a species name/Id, parameter name/Id, compartment name/Id.

void loadSBML(string)

Loads the sbml document. The input string must be a valid sbml document. An exception will be thrown if there are fatal errors in the input string.

string validateSBML(string)

Validates the input sbml document. The input string must be a valid sbml document. An exception will be thrown if there are fatal errors in the input string.

string getSBML()

Returns the currently loaded sbml document

string getParamPromotedSBML(string)

Modifies the names of local parameters by adding reaction name at the beginning and promotes them to global.

string getModelName()

Returns the modelName/Id given in sbml document

string getModelId()

Returns the modelId/Name given in sbml document

int getNumFunctionDefinitions()

Returns the number offunction Definitions listed in the sbml document

int getNumCompartments()

Returns the number of compartments listed in the sbml document

int getNumReactions()

Returns the number of reactions listed in the sbml document

int getNumFloatingSpecies()

Returns the number of floating species in the sbml document

int getNumBoundarySpecies()

Returns the number of boundary species in the sbml document

int getNumGlobalParameters()

Returns the number of global parameters in the sbml document

{} getNthFunctionDefinition(int)

The return type is a list containing {functionId, list of arguments, function body}. The index can vary from 0 to (numOfFunctionDefinitions-1). If the index exceeds the total number of function Definitions then the method throws an exception

{} getNthListOfModifiers(int)

The return type is a list containing {species id's} where the species modify the reaction. The index can vary from 0 to (numReactions-1). If the index exceeds the total number of reactions then the method throws an exception

{} getNthListOfReactants(int)

The return type is a list containing lists of {species id's and stoichiometry} that are reactants of the reaction. The index can vary from 0 to (numReactions-1). If the index exceeds the total number of reactions then the method throws an exception

{} getNthListOfProducts(int)

The return type is a list containing lists of {species id's and stoichiometry} that are products of the reaction. The index can vary from 0 to (numReactions-1). If the index exceeds the total number of reactions then the method throws an exception

string getNthCompartmentName(int)

Returns the name of compartment for the input index. The index can vary from 0 to (numOfCompartments-1). If the index exceeds the total number of compartments then the method throws an exception

string getNthCompartmentId(int)

Returns the Id of compartment for the input index. The index can vary from 0 to (numOfCompartments-1). If the index exceeds the total number of compartments then the method throws an exception

string getOutsideCompartment(string)

Returns the outside compartment for the input. The input should be a compartment name for level 1 and compartment id for level 2. Throws an exception if the id or name is not found.

{} getListOfFloatingSpeciesIds()

Returns a list of all the floating speciesIds.

{} getListOfFloatingSpecies()

Returns a list of all the floating species and their values together with and indicator whether this value is a concentration (true) or an amount (false). The return type will be a list of lists ex:- {{“S1”,1.0,True},{“S2”,2.0,False}}

string getNthFloatingSpeciesName(int)

Returns the name of the floatingSpecies for the input index. The index can vary from 0 to (numOfFloatingSpecies-1). If the index exceeds the total number of floatingSpecies then the method throws an exception

string getNthFloatingSpeciesId(int)

Returns the id of the floatingSpecies for the input index. The index can vary from 0 to (numOfFloatingSpecies-1). If the index exceeds the total number of floatingSpecies then the method throws an exception

{} getListOfBoundarySpeciesIds()

Returns a list of all the Boundary speciesIds.

{} getListOfBoundarySpecies()

Returns a list of all the boundary species and their values together with and indicator whether this value is a concentration (true) or an amount (false). The return type will be a list of lists ex:- {{“S1”,1.0,True},{“S2”,2.0,False}}

string getNthBoundarySpeciesName(int)

Returns the name of the boundarySpecies for the input index. The index can vary from 0 to (numOfBoundarySpecies-1). If the index exceeds the total number of boundarySpecies then the method throws an exception

string getNthBoundarySpeciesId(int)

Returns the id of the boundarySpecies for the input index. The index can vary from 0 to (numOfBoundarySpecies-1). If the index exceeds the total number of boundarySpecies then the method throws an exception

string getCompartmentIdBySpeciesId(string)

Returns the name/Id of the compartment where the Species with the given speciesId is located

string getNthFloatingSpeciesCompartmentName(int)

Returns the name of the compartment where the floatingSpecies with the given index is located

string getNthBoundarySpeciesCompartmentName(int)

Returns the name of the compartment where the floatingSpecies with the given index is located

boolean isReactionReversible(int)

Returns 1 if the reaction for the input index value is reversible and 0 otherwise. The index can vary from 0 to (numOfReactions-1). If the index exceeds the total number of Reactions then the method throws an exception

string getNthReactionName(int)

Returns the name of the reaction for the input index value. The index can vary from 0 to (numOfReactions-1). If the index exceeds the total number of Reactions then the method throws an exception

string getNthReactionId(int)

Returns the id of the reaction for the input index value. The index can vary from 0 to (numOfReactions-1). If the index exceeds the total number of Reactions then the method throws an exception

int getNumReactants(int)

Returns the number of reactants for tbe reaction index. The index can vary from 0 to (numOfReactions-1). If the index exceeds the total number of Reactions then the method throws an exception

int getNumProducts(int)

Returns the number of products for tbe reaction index. The index can vary from 0 to (numOfReactions-1). If the index exceeds the total number of Reactions then the method throws an exception

string getNthReactantName(int,int)

Returns the name of reactant for the indicies values provided. The first input is the reaction index and it can vary from 0 to (numOfReactions-1). The second index varies from 0 to (numberOfReactants-1) of the input reaction index. If the first index exceeds the total number of Reactions or the second index exceeds the total number of reactants of the reaction then the method throws an exception

string getNthProductName(int,int)

Returns the name of product for the indicies values provided. The first input is the reaction index and it can vary from 0 to (numOfReactions-1). The second index varies from 0 to (numberOfProducts-1) of the input reaction index. If the first index exceeds the total number of Reactions or the second index exceeds the total number of products of the reaction then the method throws an exception

string getKineticLaw(int)

Returns the Kineticlaw of reaction at the index value provided. The index can vary from 0 to (numOfReactions-1). If the index exceeds the total number of Reactions then the method throws an exception

int getNthReactantStoichiometry(int,int)

Returns the name of stoichiometry value for the indicies values provided. The first input is the reaction index and it can vary from 0 to (numOfReactions-1). The second index varies from 0 to (numberOfReactants-1) of the input reaction index. If the first index exceeds the total number of Reactions or the second index exceeds the total number of products of the reaction then the method throws an exception

int getNthProductStoichiometry(int,int)

Returns the name of stoichiometry value for the indicies values provided. The first input is the reaction index and it can vary from 0 to (numOfReactions-1). The second index varies from 0 to (numberOfProducts-1) of the input reaction index. If the first index exceeds the total number of Reactions or the second index exceeds the total number of products of the reaction then the method throws an exception

double getNthReactantStoichiometryDouble(int,int)

Returns the name of stoichiometry value for the indicies values provided. The first input is the reaction index and it can vary from 0 to (numOfReactions-1). The second index varies from 0 to (numberOfReactants-1) of the input reaction index. If the first index exceeds the total number of Reactions or the second index exceeds the total number of products of the reaction then the method throws an exception

double getNthProductStoichiometryDouble(int,int)

Returns the name of stoichiometry value for the indicies values provided. The first input is the reaction index and it can vary from 0 to (numOfReactions-1). The second index varies from 0 to (numberOfProducts-1) of the input reaction index. If the first index exceeds the total number of Reactions or the second index exceeds the total number of products of the reaction then the method throws an exception

{} getListOfParameters()

Returns a list of both the global & local parameters and their values. The return type will be a list of lists ex:- {{“K1”,1.0},{“K2”,2.0}}

int getNumParameters(int)

Returns the total number of local parameters for the input reaction index.

string getNthParameterName(int,int)

Returns the name of the parameter for the indicies values provided. The first input is the reaction index and it can vary from 0 to (numOfReactions-1). The second index varies from 0 to (localParameters-1) of the input reaction index. If the first index exceeds the total number of Reactions or the second index exceeds the total number of Parameters of the reaction then the method throws an exception

string getNthParameterId(int,int)

Returns the id of the parameter for the indicies values provided. The first input is the reaction index and it can vary from 0 to (numOfReactions-1). The second index varies from 0 to (localParameters-1) of the input reaction index. If the first index exceeds the total number of Reactions or the second index exceeds the total number of Parameters of the reaction then the method throws an exception

double getNthParameterValue(int,int)

Returns the value of parameter for the indicies values provided. The first input is the reaction index and it can vary from 0 to (numOfReactions-1). The second index varies from 0 to (numberOfParameters-1) of the input reaction index. If the first index exceeds the total number of Reactions or the second index exceeds the total number of Parameters of the reaction then the method throws an exception

boolean getNthParameterHasValue(int,int)

Returns 1 if a value is assigned to the parameter for the indicies values provided and 0 otherwise. The first input is the reaction index and it can vary from 0 to (numOfReactions-1). The second index varies from 0 to (numberOfParameters-1) of the input reaction index. If the first index exceeds the total number of Reactions or the second index exceeds the total number of Parameters of the reaction then the method throws an exception

string getNthGlobalParameterName(int)

Returns the name of the global parameter at index values provided. The index can vary from 0 to (numOfGlobalParameters-1). If the index exceeds the total number of Global Parameters then the method throws an exception

string getNthGlobalParameterId(int)

Returns the id of the global parameter at index values provided. The index can vary from 0 to (numOfGlobalParameters-1). If the index exceeds the total number of Global Parameters then the method throws an exception

int getNumRules()

Returns the total number of Rules in the sbml.

string getNthRule(int)

Returns the rule at the index value provided. The index can vary from 0 to (numOfRules-1). If the index exceeds the total number of rules then the method throws an exception.

string getNthRuleType(int)

The return string indicates the type of rule at the index provided. Eg., 'Assignment_Rule', 'Algebraic_Rule', 'Rate_Rule', 'Parameter_Rule'; 'Species_Concentration_Rule'; 'Compartment_Volume_Rule'. The index can vary from 0 to (numOfRules-1). If the index exceeds the total number of rules then the method throws an exception.

int getNumEvents()

Returns the total number of Event in the sbml.

{} getNthEvent(int)

Returns the event at the index value provided. The return type is a list containing {trigger, delay, {lValue_eventAssignment1, rValue_eventAssignment1}, {lValue_eventAssignment2, rValue_eventAssignment2}, …} The index can vary from 0 to (numOfEvents-1). If the index exceeds the total number of events then the method throws an exception.

boolean hasValue(string)

Returns the 1 if the input string has a value and 0 otherwise. The input string can be a species name/Id, parameter name/Id, compartment name/Id.

string[] getBuiltinFunctionInfo(string)

Returns the description of the builtin funtion for the input string provided.

string[] getBuiltinFunctions()

Returns a list of strings of all the builtin functions.

string convertMathMLToString(string)

Converts a MathML string to mathematical infix expression.

string convertStringToMathML(string)

Converts a mathematical infix expression to a MathML string.

string convertLevel1ToLevel2Impl(string)

Converts a SBML level 1 document to level2 document.

string convertLevel2ToLevel1Impl(string)

Converts a SBML level 2 document to level1 document.

string convertPowImpl(string)

Converts a power tag to \^. The input is a valid sbml string. The output is also an sbml string with power expressions converted.

void setValue(string,double)

Sets the value of the species name/Id, parameter name/Id, compartment name/Id to the given value.

boolean hasInitialAmount(string)

Returns True if the given species name/Id has an initial amount set, False otherwise.

boolean hasInitialConcentration(string)

Returns True if the given species name/Id has an initial concentration set, False otherwise.

 
sbw/sbmlsupport/api.txt · Last modified: 2007/01/12 07:28 (external edit)
 

    Home  |   About Us  |   Contact Us  |   Statistics
Recent changes RSS feed Creative Commons License Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki