sbmlResults.h File Reference

#include "sbmlsolver/exportdefs.h"

Include dependency graph for sbmlResults.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	timeCourse
	A simple structure containing a variable name, and its time courses generated by simulation routines. More...
struct	timeCourseArray
	A simple structure containing num_val time courses. More...
struct	_SBMLResults
	A simple structure that contains time courses - represented by the timeCourseArray structure - for SBML structures, such as species, non-constant compartments and parameters and reaction fluxes. More...
struct	_SBMLResultsMatrix
	A matrix of _SBMLResults used for batch integration with parameter variation via varySettings. More...
Typedefs
typedef timeCourse	timeCourse_t
typedef timeCourseArray	timeCourseArray_t
typedef _SBMLResults	SBMLResults_t
typedef _SBMLResultsMatrix	SBMLResultsMatrix_t
Functions
SBML_ODESOLVER_API timeCourse_t *	SBMLResults_getTime (SBMLResults_t *)
	Returns the timeCourse for the integration time points.
SBML_ODESOLVER_API timeCourse_t *	SBMLResults_getTimeCourse (SBMLResults_t *, const char *)
	Returns the timeCourse for a species, variable compartment or parameter or a reaction flux with the corresponding SBML ID.
SBML_ODESOLVER_API int	SBMLResults_getNout (SBMLResults_t *)
	Returns the number of time points, including initial time.
SBML_ODESOLVER_API int	SBMLResults_getNumSens (SBMLResults_t *)
	Returns the number of model constants for which sensitivities have been calculated.
SBML_ODESOLVER_API const char *	SBMLResults_getSensParam (SBMLResults_t *, int)
	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 *, SBMLResults_t *)
	Returns the timeCourse for a variable (non-constant) compartment.
SBML_ODESOLVER_API timeCourse_t *	Species_getTimeCourse (Species_t *, SBMLResults_t *)
	Returns the timeCourse for a species, whether constant or not.
SBML_ODESOLVER_API timeCourse_t *	Parameter_getTimeCourse (Parameter_t *, SBMLResults_t *)
	Returns the timeCourse for a variable (non-constant) parameters.
SBML_ODESOLVER_API const char *	TimeCourse_getName (timeCourse_t *)
	Returns the variable name (SBML ID) of a timeCourse.
SBML_ODESOLVER_API int	TimeCourse_getNumValues (timeCourse_t *)
	Returns the number of timepoints in a timeCourse.
SBML_ODESOLVER_API double	TimeCourse_getValue (timeCourse_t *, int)
	Returns ith value in a timeCourse, where 0 <= i < TimeCourse_getNumValues.
SBML_ODESOLVER_API double	TimeCourse_getSensitivity (timeCourse_t *, int, int)
	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_dump (SBMLResults_t *)
	Prints the timeCourses of all SBML species, of variable compartments and parameters, and of reaction fluxes.
SBML_ODESOLVER_API void	SBMLResults_dumpSpecies (SBMLResults_t *)
	Prints the timeCourses of all SBML species.
SBML_ODESOLVER_API void	SBMLResults_dumpCompartments (SBMLResults_t *)
	Prints the timeCourses of all variable SBML compartments.
SBML_ODESOLVER_API void	SBMLResults_dumpParameters (SBMLResults_t *)
	Prints the timeCourses of all variable SBML parameters.
SBML_ODESOLVER_API void	SBMLResults_dumpFluxes (SBMLResults_t *)
	Prints the timeCourses of all SBML reaction fluxes.
SBML_ODESOLVER_API void	SBMLResults_free (SBMLResults_t *)
	Frees SBMLResults structure.
SBML_ODESOLVER_API void	SBMLResultsMatrix_free (SBMLResultsMatrix_t *)
	Frees the SBMLResultMatrix from a parameter variation batch run.
SBML_ODESOLVER_API SBMLResults_t *	SBMLResultsMatrix_getResults (SBMLResultsMatrix_t *, int i, int j)
	Returns the SBMLResults for the jth value of the ith parameter from a parameter variation batch run SBMLResultMatrix.
SBMLResults_t *	SBMLResults_create (Model_t *, int timepoints)
SBMLResultsMatrix_t *	SBMLResultsMatrix_allocate (int values, int timepoints)

---

Typedef Documentation

typedef struct timeCourse timeCourse_t

typedef struct timeCourseArray timeCourseArray_t

typedef struct _SBMLResults SBMLResults_t

typedef struct _SBMLResultsMatrix SBMLResultsMatrix_t

---