Main Page | Modules | Data Structures | Directories | File List | Data Fields | Globals

SBML Results Interface
[High Level Interfaces]

Collaboration diagram for SBML Results Interface:

This module contains interfaces to the results structures returned by the high level interfaces to SOSlib. More...

Functions

SBML_ODESOLVER_API SBMLResults_tSBMLResults_fromIntegrator (Model_t *m, integratorInstance_t *ii)
 Maps the integration results from internal data structures back to SBML structures (compartments, species, parameters and reaction fluxes).
SBMLResults_tSBMLResults_create (Model_t *m, int timepoints)
SBML_ODESOLVER_API timeCourse_tSBMLResults_getTime (SBMLResults_t *results)
 Returns the timeCourse for the integration time points.
SBML_ODESOLVER_API int SBMLResults_getNout (SBMLResults_t *res)
 Returns the number of time points, including initial time.
SBML_ODESOLVER_API int SBMLResults_getNumSens (SBMLResults_t *res)
 Returns the number of model constants for which sensitivities have been calculated.
SBML_ODESOLVER_API const char * SBMLResults_getSensParam (SBMLResults_t *res, int i)
 Returns the name (SBML ID) of the ith constants for which sensitivities have been calculated, where 0 <= i < SBMLResults_getNumSens.
SBML_ODESOLVER_API timeCourse_tCompartment_getTimeCourse (Compartment_t *c, SBMLResults_t *results)
 Returns the timeCourse for a variable (non-constant) compartment.
SBML_ODESOLVER_API timeCourse_tSpecies_getTimeCourse (Species_t *s, SBMLResults_t *results)
 Returns the timeCourse for a species, whether constant or not.
SBML_ODESOLVER_API timeCourse_tParameter_getTimeCourse (Parameter_t *p, SBMLResults_t *results)
 Returns the timeCourse for a variable (non-constant) parameters.
SBML_ODESOLVER_API timeCourse_tSBMLResults_getTimeCourse (SBMLResults_t *results, const char *id)
 Returns the timeCourse for a species, variable compartment or parameter or a reaction flux with the corresponding SBML ID.
SBML_ODESOLVER_API const char * TimeCourse_getName (timeCourse_t *tc)
 Returns the variable name (SBML ID) of a timeCourse.
SBML_ODESOLVER_API int TimeCourse_getNumValues (timeCourse_t *tc)
 Returns the number of timepoints in a timeCourse.
SBML_ODESOLVER_API double TimeCourse_getValue (timeCourse_t *tc, int i)
 Returns ith value in a timeCourse, where 0 <= i < TimeCourse_getNumValues.
SBML_ODESOLVER_API double TimeCourse_getSensitivity (timeCourse_t *tc, int i, int j)
 Returns the sensitivity to ith constant at jth time step, where 0 <= i < SBMLResults_getNumSens, and 0 <= j < TimeCourse_getNumValues.
SBML_ODESOLVER_API void SBMLResults_free (SBMLResults_t *results)
 Frees SBMLResults structure.
SBML_ODESOLVER_API void SBMLResults_dumpSpecies (SBMLResults_t *results)
 Prints the timeCourses of all SBML species.
SBML_ODESOLVER_API void SBMLResults_dumpCompartments (SBMLResults_t *results)
 Prints the timeCourses of all variable SBML compartments.
SBML_ODESOLVER_API void SBMLResults_dumpParameters (SBMLResults_t *results)
 Prints the timeCourses of all variable SBML parameters.
SBML_ODESOLVER_API void SBMLResults_dumpFluxes (SBMLResults_t *results)
 Prints the timeCourses of all SBML reaction fluxes.
SBML_ODESOLVER_API void SBMLResults_dump (SBMLResults_t *results)
 Prints the timeCourses of all SBML species, of variable compartments and parameters, and of reaction fluxes.
SBML_ODESOLVER_API SBMLResults_tSBMLResultsMatrix_getResults (SBMLResultsMatrix_t *resM, int i, int j)
 Returns the SBMLResults for the jth value of the ith parameter from a parameter variation batch run SBMLResultMatrix.
SBML_ODESOLVER_API void SBMLResultsMatrix_free (SBMLResultsMatrix_t *resM)
 Frees the SBMLResultMatrix from a parameter variation batch run.
SBMLResultsMatrix_tSBMLResultsMatrix_allocate (int nrparams, int nrdesignpoints)

Detailed Description

This module contains interfaces to the results structures returned by the high level interfaces to SOSlib.


Function Documentation

SBML_ODESOLVER_API SBMLResults_t* SBMLResults_fromIntegrator Model_t *  m,
integratorInstance_t ii
 

Maps the integration results from internal data structures back to SBML structures (compartments, species, parameters and reaction fluxes).

SBMLResults_t* SBMLResults_create Model_t *  m,
int  timepoints
 

SBML_ODESOLVER_API timeCourse_t* SBMLResults_getTime SBMLResults_t results  ) 
 

Returns the timeCourse for the integration time points.

SBML_ODESOLVER_API int SBMLResults_getNout SBMLResults_t res  ) 
 

Returns the number of time points, including initial time.

SBML_ODESOLVER_API int SBMLResults_getNumSens SBMLResults_t res  ) 
 

Returns the number of model constants for which sensitivities have been calculated.

SBML_ODESOLVER_API const char* SBMLResults_getSensParam SBMLResults_t res,
int  i
 

Returns the name (SBML ID) of the ith constants for which sensitivities have been calculated, where 0 <= i < SBMLResults_getNumSens.

SBML_ODESOLVER_API timeCourse_t* Compartment_getTimeCourse Compartment_t *  c,
SBMLResults_t results
 

Returns the timeCourse for a variable (non-constant) compartment.

For a constant compartment NULL is returned.

SBML_ODESOLVER_API timeCourse_t* Species_getTimeCourse Species_t *  s,
SBMLResults_t results
 

Returns the timeCourse for a species, whether constant or not.

SBML_ODESOLVER_API timeCourse_t* Parameter_getTimeCourse Parameter_t *  p,
SBMLResults_t results
 

Returns the timeCourse for a variable (non-constant) parameters.

For a constant parameter NULL is returned.

SBML_ODESOLVER_API timeCourse_t* SBMLResults_getTimeCourse SBMLResults_t results,
const char *  id
 

Returns the timeCourse for a species, variable compartment or parameter or a reaction flux with the corresponding SBML ID.

SBML_ODESOLVER_API const char* TimeCourse_getName timeCourse_t tc  ) 
 

Returns the variable name (SBML ID) of a timeCourse.

SBML_ODESOLVER_API int TimeCourse_getNumValues timeCourse_t tc  ) 
 

Returns the number of timepoints in a timeCourse.

SBML_ODESOLVER_API double TimeCourse_getValue timeCourse_t tc,
int  i
 

Returns ith value in a timeCourse, where 0 <= i < TimeCourse_getNumValues.

SBML_ODESOLVER_API double TimeCourse_getSensitivity timeCourse_t tc,
int  i,
int  j
 

Returns the sensitivity to ith constant at jth time step, where 0 <= i < SBMLResults_getNumSens, and 0 <= j < TimeCourse_getNumValues.

SBML_ODESOLVER_API void SBMLResults_free SBMLResults_t results  ) 
 

Frees SBMLResults structure.

SBML_ODESOLVER_API void SBMLResults_dumpSpecies SBMLResults_t results  ) 
 

Prints the timeCourses of all SBML species.

SBML_ODESOLVER_API void SBMLResults_dumpCompartments SBMLResults_t results  ) 
 

Prints the timeCourses of all variable SBML compartments.

SBML_ODESOLVER_API void SBMLResults_dumpParameters SBMLResults_t results  ) 
 

Prints the timeCourses of all variable SBML parameters.

SBML_ODESOLVER_API void SBMLResults_dumpFluxes SBMLResults_t results  ) 
 

Prints the timeCourses of all SBML reaction fluxes.

SBML_ODESOLVER_API void SBMLResults_dump SBMLResults_t results  ) 
 

Prints the timeCourses of all SBML species, of variable compartments and parameters, and of reaction fluxes.

SBML_ODESOLVER_API SBMLResults_t* SBMLResultsMatrix_getResults SBMLResultsMatrix_t resM,
int  i,
int  j
 

Returns the SBMLResults for the jth value of the ith parameter from a parameter variation batch run SBMLResultMatrix.

SBML_ODESOLVER_API void SBMLResultsMatrix_free SBMLResultsMatrix_t resM  ) 
 

Frees the SBMLResultMatrix from a parameter variation batch run.

SBMLResultsMatrix_t* SBMLResultsMatrix_allocate int  nrparams,
int  nrdesignpoints
 


Generated on Wed Dec 21 18:10:38 2005 for SBML ODE Solver Library API by  doxygen 1.4.4