libroadrunner C API
rrc_api.h
Go to the documentation of this file.
1 
41 #ifndef rrc_apiH
42 #define rrc_apiH
43 #include "rrc_exporter.h"
44 #include "rrc_types.h"
45 #include "rrc_utilities.h"
46 #include "rrc_logging_api.h"
47 #include "rrc_nom_api.h"
48 #include "rrc_libstruct_api.h"
49 
50 #if defined(__cplusplus)
51 namespace rrc { extern "C" {
52 #endif
53 
59 C_DECL_SPEC RRHandle rrcCallConv createRRInstance(void);
60 
71 C_DECL_SPEC RRHandle rrcCallConv createRRInstanceEx(const char* tempFolder, const char* compiler);
72 
78 C_DECL_SPEC bool rrcCallConv freeRRInstance(RRHandle handle);
79 
85 char* getInstallFolder(void);
86 
93 C_DECL_SPEC bool rrcCallConv setInstallFolder(const char* folder);
94 
100 C_DECL_SPEC char* rrcCallConv getAPIVersion(void);
101 
108 C_DECL_SPEC char* rrcCallConv getCPPAPIVersion(RRHandle handle);
109 
120 C_DECL_SPEC int rrcCallConv getVersion();
121 
125 C_DECL_SPEC char* rrcCallConv getVersionStr();
126 
127 
131 C_DECL_SPEC char* rrcCallConv getVersionEx();
132 
138 C_DECL_SPEC char* rrcCallConv getExtendedAPIInfo();
139 
145 C_DECL_SPEC char* rrcCallConv getBuildDate(void);
146 
152 C_DECL_SPEC char* rrcCallConv getBuildTime(void);
153 
159 C_DECL_SPEC char* rrcCallConv getBuildDateTime(void);
160 
166 C_DECL_SPEC char* rrcCallConv getCopyright(void);
167 
174 C_DECL_SPEC char* rrcCallConv getInfo(RRHandle handle);
175 
182 C_DECL_SPEC char* rrcCallConv getlibSBMLVersion(RRHandle handle);
183 
195 C_DECL_SPEC bool rrcCallConv setTempFolder(RRHandle handle, const char* folder);
196 
207 C_DECL_SPEC char* rrcCallConv getTempFolder(RRHandle handle);
208 
215 C_DECL_SPEC char* rrcCallConv getWorkingDirectory(void);
216 
223 C_DECL_SPEC char* rrcCallConv getRRCAPILocation(void);
224 
225 
233 C_DECL_SPEC bool rrcCallConv setCompiler(RRHandle handle, const char* fNameWithPath);
234 
239 C_DECL_SPEC char* rrcCallConv getCompiler(RRHandle handle);
240 
249 C_DECL_SPEC bool rrcCallConv setCompilerLocation(RRHandle handle, const char* folder);
250 
259 C_DECL_SPEC char* rrcCallConv getCompilerLocation(RRHandle handle);
260 
268 C_DECL_SPEC bool rrcCallConv setSupportCodeFolder(RRHandle handle, const char* folder);
269 
278 C_DECL_SPEC char* rrcCallConv getSupportCodeFolder(RRHandle handle);
279 
293 C_DECL_SPEC bool rrcCallConv setCodeGenerationMode(RRHandle handle, int mode);
294 
295 
304 C_DECL_SPEC bool rrcCallConv hasError(void);
305 
314 C_DECL_SPEC char* rrcCallConv getLastError(void);
315 
316 // Flags/Options
324 C_DECL_SPEC bool rrcCallConv setComputeAndAssignConservationLaws(RRHandle handle, const bool On_Or_Off);
325 
333 C_DECL_SPEC int rrcCallConv getComputeAndAssignConservationLaws(RRHandle handle, int* value);
334 
335 // -----------------------------------------------------------------------
336 // Read and Write models
337 // -----------------------------------------------------------------------
338 
346 C_DECL_SPEC bool rrcCallConv loadSBML(RRHandle handle, const char* sbml);
347 
356 C_DECL_SPEC bool rrcCallConv loadSBMLEx(RRHandle handle, const char* sbml, bool forceRecompile);
357 
365 C_DECL_SPEC bool rrcCallConv saveState(RRHandle handle, const char* filename);
366 
367 
375 C_DECL_SPEC bool rrcCallConv loadState(RRHandle handle, const char* filename);
376 
384 //C_DECL_SPEC bool rrcCallConv loadSBMLFromFile(const char* fileName);
385 C_DECL_SPEC bool rrcCallConv loadSBMLFromFile(RRHandle handle, const char* fileName);
386 
395 C_DECL_SPEC bool rrcCallConv loadSBMLFromFileE(RRHandle handle, const char* fileName, bool forceRecompile);
396 
403 C_DECL_SPEC bool rrcCallConv clearModel(RRHandle handle);
404 
411 C_DECL_SPEC bool rrcCallConv isModelLoaded(RRHandle handle);
412 
421 C_DECL_SPEC bool rrcCallConv loadSimulationSettings(RRHandle handle, const char* fileName);
422 
429 C_DECL_SPEC char* rrcCallConv getCurrentSBML(RRHandle handle);
430 
437 C_DECL_SPEC char* rrcCallConv getSBML(RRHandle handle);
438 
439 
440 // -------------------------------------------------------------------------------------
441 // Model editing methods
442 // -------------------------------------------------------------------------------------
443 
444 
455 C_DECL_SPEC bool rrcCallConv addSpecies(RRHandle handle, const char* sid, const char* compartment, double initialAmount, bool hasOnlySubstanceUnits, bool boundaryCondition);
456 
468 C_DECL_SPEC bool rrcCallConv addSpeciesNoRegen(RRHandle handle, const char* sid, const char* compartment, double initialAmount, bool hasOnlySubstanceUnits, bool boundaryCondition);
469 
470 
478 C_DECL_SPEC bool rrcCallConv removeSpecies(RRHandle handle, const char* sid);
479 
488 C_DECL_SPEC bool rrcCallConv removeSpeciesNoRegen(RRHandle handle, const char* sid);
489 
498 C_DECL_SPEC bool rrcCallConv setBoundary(RRHandle handle, const char* sid, bool boundaryCondition);
499 
509 C_DECL_SPEC bool rrcCallConv setBoundaryNoRegen(RRHandle handle, const char* sid, bool boundaryCondition);
510 
511 
520 C_DECL_SPEC bool rrcCallConv setHasOnlySubstanceUnits(RRHandle handle, const char* sid, bool hasOnlySubstanceUnits);
521 
531 C_DECL_SPEC bool rrcCallConv setHasOnlySubstanceUnitsNoRegen(RRHandle handle, const char* sid, bool hasOnlySubstanceUnits);
532 
533 
534 
543 C_DECL_SPEC bool rrcCallConv setInitAmount(RRHandle handle, const char* sid, double initAmount);
544 
554 C_DECL_SPEC bool rrcCallConv setInitAmountNoRegen(RRHandle handle, const char* sid, double initAmount);
555 
564 C_DECL_SPEC bool rrcCallConv setInitConcentration(RRHandle handle, const char* sid, double initConcentration);
565 
575 C_DECL_SPEC bool rrcCallConv setInitConcentrationNoRegen(RRHandle handle, const char* sid, double initConcentration);
576 
577 
586 C_DECL_SPEC bool rrcCallConv setConstant(RRHandle handle, const char* sid, bool constant);
587 
597 C_DECL_SPEC bool rrcCallConv setConstantNoRegen(RRHandle handle, const char* sid, bool constant);
598 
599 
607 C_DECL_SPEC bool rrcCallConv addReactionFromSBML(RRHandle handle, const char* sbmlRep);
608 
617 C_DECL_SPEC bool rrcCallConv addReactionFromSBMLNoRegen(RRHandle handle, const char* sbmlRep);
618 
631 C_DECL_SPEC bool rrcCallConv addReaction(RRHandle handle, const char* rid, const char** reactants, int numReactants,
632  const char** products, int numProducts, const char* kineticLaw);
633 
647 C_DECL_SPEC bool rrcCallConv addReactionNoRegen(RRHandle handle, const char* rid, const char** reactants, int numReactants,
648  const char** products, int numProducts, const char* kineticLaw);
649 
657 C_DECL_SPEC bool rrcCallConv removeReaction(RRHandle handle, const char* rid);
658 
659 
668 C_DECL_SPEC bool rrcCallConv removeReactionNoRegen(RRHandle handle, const char* rid);
669 
678 C_DECL_SPEC bool rrcCallConv setReversible(RRHandle handle, const char* rid, bool reversible);
679 
689 C_DECL_SPEC bool rrcCallConv setReversibleNoRegen(RRHandle handle, const char* rid, bool reversible);
690 
691 
700 C_DECL_SPEC bool rrcCallConv setKineticLaw(RRHandle handle, const char* rid, const char* kineticLaw);
701 
711 C_DECL_SPEC bool rrcCallConv setKineticLawNoRegen(RRHandle handle, const char* rid, const char* kineticLaw);
712 
713 
721 C_DECL_SPEC char* rrcCallConv getKineticLaw(RRHandle handle, const char* rid);
722 
731 C_DECL_SPEC bool rrcCallConv addParameter(RRHandle handle, const char* pid, double value);
741 C_DECL_SPEC bool rrcCallConv addParameterNoRegen(RRHandle handle, const char* pid, double value);
742 
750 C_DECL_SPEC bool rrcCallConv removeParameter(RRHandle handle, const char* pid);
751 
752 
761 C_DECL_SPEC bool rrcCallConv removeParameterNoRegen(RRHandle handle, const char* pid);
762 
763 
772 C_DECL_SPEC bool rrcCallConv addCompartment(RRHandle handle, const char* cid, double initVolume);
782 C_DECL_SPEC bool rrcCallConv addCompartmentNoRegen(RRHandle handle, const char* cid, double initVolume);
783 
784 
792 C_DECL_SPEC bool rrcCallConv removeCompartment(RRHandle handle, const char* cid);
793 
794 
803 C_DECL_SPEC bool rrcCallConv removeCompartmentNoRegen(RRHandle handle, const char* cid);
804 
805 
806 
815 C_DECL_SPEC bool rrcCallConv addAssignmentRule(RRHandle handle, const char* vid, const char* formula);
816 
826 C_DECL_SPEC bool rrcCallConv addAssignmentRuleNoRegen(RRHandle handle, const char* vid, const char* formula);
827 
836 C_DECL_SPEC bool rrcCallConv addRateRule(RRHandle handle, const char* vid, const char* formula);
837 
847 C_DECL_SPEC bool rrcCallConv addRateRuleNoRegen(RRHandle handle, const char* vid, const char* formula);
848 
856 C_DECL_SPEC bool rrcCallConv removeRules(RRHandle handle, const char* vid);
857 
858 
867 C_DECL_SPEC bool rrcCallConv removeRulesNoRegen(RRHandle handle, const char* vid);
868 
878 C_DECL_SPEC bool rrcCallConv addEvent(RRHandle handle, const char* eid, bool useValuesFromTriggerTime, const char* trigger);
879 
890 C_DECL_SPEC bool rrcCallConv addEventNoRegen(RRHandle handle, const char* eid, bool useValuesFromTriggerTime, const char* trigger);
891 
901 C_DECL_SPEC bool rrcCallConv addTrigger(RRHandle handle, const char* eid, const char* trigger);
902 
913 C_DECL_SPEC bool rrcCallConv addTriggerNoRegen(RRHandle handle, const char* eid, const char* trigger);
914 
923 C_DECL_SPEC bool rrcCallConv setPersistent(RRHandle handle, const char* eid, bool persistent);
924 
934 C_DECL_SPEC bool rrcCallConv setPersistentNoRegen(RRHandle handle, const char* eid, bool persistent);
935 
936 
945 C_DECL_SPEC bool rrcCallConv setTriggerInitialValue(RRHandle handle, const char* eid, bool initValue);
946 
956 C_DECL_SPEC bool rrcCallConv setTriggerInitialValueNoRegen(RRHandle handle, const char* eid, bool initValue);
957 
958 
968 C_DECL_SPEC bool rrcCallConv addPriority(RRHandle handle, const char* eid, const char* priority);
969 
980 C_DECL_SPEC bool rrcCallConv addPriorityNoRegen(RRHandle handle, const char* eid, const char* priority);
981 
991 C_DECL_SPEC bool rrcCallConv addDelay(RRHandle handle, const char* eid, const char* delay);
992 
1003 C_DECL_SPEC bool rrcCallConv addDelayNoRegen(RRHandle handle, const char* eid, const char* delay);
1004 
1014 C_DECL_SPEC bool rrcCallConv addEventAssignment(RRHandle handle, const char* eid, const char* vid, const char* formula);
1015 
1026 C_DECL_SPEC bool rrcCallConv addEventAssignmentNoRegen(RRHandle handle, const char* eid, const char* vid, const char* formula);
1027 
1036 C_DECL_SPEC bool rrcCallConv removeEventAssignments(RRHandle handle, const char* eid, const char* vid);
1037 
1047 C_DECL_SPEC bool rrcCallConv removeEventAssignmentsNoRegen(RRHandle handle, const char* eid, const char* vid);
1048 
1056 C_DECL_SPEC bool rrcCallConv removeEvent(RRHandle handle, const char* eid);
1057 
1066 C_DECL_SPEC bool rrcCallConv removeEventsNoRegen(RRHandle handle, const char* eid);
1067 
1074 C_DECL_SPEC bool rrcCallConv validateCurrentSBML(RRHandle handle);
1075 
1076 
1077 // -------------------------------------------------------------------------
1078 // SBML utility methods
1079 // -----------------------------------------------------------------------
1092 C_DECL_SPEC char* rrcCallConv getParamPromotedSBML(RRHandle handle, const char* sArg);
1093 
1101 C_DECL_SPEC bool rrcCallConv setConfigurationXML (RRHandle handle, const char* caps);
1102 
1135 C_DECL_SPEC char* rrcCallConv getConfigurationXML(RRHandle handle);
1136 
1137 /* Registered Integrators *****************************************************/
1138 
1144 C_DECL_SPEC int rrcCallConv getNumRegisteredIntegrators ();
1145 
1152 C_DECL_SPEC char* rrcCallConv getRegisteredIntegratorName (int n);
1153 
1160 C_DECL_SPEC char* rrcCallConv getRegisteredIntegratorHint (int n);
1161 
1168 C_DECL_SPEC char* rrcCallConv getRegisteredIntegratorDescription (int n);
1169 
1170 /* Instantiated Integrators ***************************************************/
1171 
1179 C_DECL_SPEC int rrcCallConv getNumInstantiatedIntegrators (RRHandle handle);
1180 
1190 C_DECL_SPEC int rrcCallConv setCurrentIntegrator (RRHandle handle, char *nameOfIntegrator);
1191 
1198 C_DECL_SPEC char* rrcCallConv getCurrentIntegratorName (RRHandle handle);
1199 
1206 C_DECL_SPEC char* rrcCallConv getCurrentIntegratorDescription (RRHandle handle);
1207 
1214 C_DECL_SPEC char* rrcCallConv getCurrentIntegratorHint (RRHandle handle);
1215 
1222 C_DECL_SPEC int rrcCallConv getNumberOfCurrentIntegratorParameters (RRHandle handle);
1223 
1230 C_DECL_SPEC char* rrcCallConv getCurrentIntegratorNthParameterName (RRHandle handle, int n);
1231 
1238 C_DECL_SPEC char* rrcCallConv getCurrentIntegratorNthParameterDescription (RRHandle handle, int n);
1239 
1246 C_DECL_SPEC char* rrcCallConv getCurrentIntegratorNthParameterDisplayName (RRHandle handle, int n);
1247 
1254 C_DECL_SPEC char* rrcCallConv getCurrentIntegratorNthParameterHint (RRHandle handle, int n);
1255 
1262 C_DECL_SPEC int rrcCallConv getCurrentIntegratorNthParameterType (RRHandle handle, int n);
1263 
1270 C_DECL_SPEC int rrcCallConv resetCurrentIntegratorParameters (RRHandle handle);
1271 
1279 
1287 C_DECL_SPEC char* rrcCallConv getCurrentIntegratorParameterDescription (RRHandle handle, char *parameterName);
1288 
1296 C_DECL_SPEC char* rrcCallConv getCurrentIntegratorParameterHint (RRHandle handle, char *parameterName);
1297 
1305 C_DECL_SPEC int rrcCallConv getCurrentIntegratorParameterType (RRHandle handle, char *parameterName);
1306 
1314 C_DECL_SPEC int rrcCallConv getCurrentIntegratorParameterInt (RRHandle handle, char *parameterName);
1315 
1324 C_DECL_SPEC int rrcCallConv setCurrentIntegratorParameterInt (RRHandle handle, char *parameterName, int value);
1325 
1333 C_DECL_SPEC unsigned int rrcCallConv getCurrentIntegratorParameterUInt (RRHandle handle, char *parameterName);
1334 
1343 C_DECL_SPEC int rrcCallConv setCurrentIntegratorParameterUInt (RRHandle handle, char *parameterName, unsigned int value);
1344 
1352 C_DECL_SPEC double rrcCallConv getCurrentIntegratorParameterDouble (RRHandle handle, char *parameterName);
1353 
1362 C_DECL_SPEC int rrcCallConv setCurrentIntegratorParameterDouble (RRHandle handle, char *parameterName, double value);
1363 
1371 C_DECL_SPEC char* rrcCallConv getCurrentIntegratorParameterString (RRHandle handle, char *parameterName);
1372 
1381 C_DECL_SPEC int rrcCallConv setCurrentIntegratorParameterString (RRHandle handle, char *parameterName, char* value);
1382 
1390 C_DECL_SPEC int rrcCallConv getCurrentIntegratorParameterBoolean (RRHandle handle, char *parameterName);
1391 
1400 C_DECL_SPEC int rrcCallConv setCurrentIntegratorParameterBoolean (RRHandle handle, char *parameterName, int value);
1401 
1402 
1412 C_DECL_SPEC int rrcCallConv getCurrentIntegratorParameterDoubleArray (RRHandle handle, char *parameterName, double** value, int* len);
1413 
1423 C_DECL_SPEC int rrcCallConv setCurrentIntegratorParameterDoubleArray(RRHandle handle, char *parameterName, double* value, int len);
1424 
1425 
1433 C_DECL_SPEC int rrcCallConv setCurrentIntegratorScalarConcentrationTolerance(RRHandle handle, double value);
1434 
1435 
1444 C_DECL_SPEC int rrcCallConv setCurrentIntegratorVectorConcentrationTolerance(RRHandle handle, double* value, int len);
1445 
1446 
1456 C_DECL_SPEC int rrcCallConv setCurrentIntegratorIndividualTolerance(RRHandle handle, char* sid, double value);
1457 
1458 
1459 /* Steady State Solvers *******************************************************/
1460 
1466 C_DECL_SPEC int rrcCallConv getNumRegisteredSteadyStateSolvers ();
1467 
1474 C_DECL_SPEC char* rrcCallConv getRegisteredSteadyStateSolverName (int n);
1475 
1482 C_DECL_SPEC char* rrcCallConv getRegisteredSteadyStateSolverHint (int n);
1483 
1490 C_DECL_SPEC char* rrcCallConv getRegisteredSteadyStateSolverDescription (int n);
1491 
1492 
1502 C_DECL_SPEC int rrcCallConv setCurrentSteadyStateSolver (RRHandle handle, char *nameOfSteadyStateSolver);
1503 
1510 C_DECL_SPEC char* rrcCallConv getCurrentSteadyStateSolverName (RRHandle handle);
1511 
1518 C_DECL_SPEC char* rrcCallConv getCurrentSteadyStateSolverDescription (RRHandle handle);
1519 
1526 C_DECL_SPEC char* rrcCallConv getCurrentSteadyStateSolverHint (RRHandle handle);
1527 
1534 C_DECL_SPEC int rrcCallConv getNumberOfCurrentSteadyStateSolverParameters (RRHandle handle);
1535 
1542 C_DECL_SPEC char* rrcCallConv getCurrentSteadyStateSolverNthParameterName (RRHandle handle, int n);
1543 
1550 C_DECL_SPEC char* rrcCallConv getCurrentSteadyStateSolverNthParameterDisplayName (RRHandle handle, int n);
1551 
1558 C_DECL_SPEC char* rrcCallConv getCurrentSteadyStateSolverNthParameterDescription (RRHandle handle, int n);
1559 
1566 C_DECL_SPEC char* rrcCallConv getCurrentSteadyStateSolverNthParameterHint (RRHandle handle, int n);
1567 
1574 C_DECL_SPEC int rrcCallConv getCurrentSteadyStateSolverNthParameterType (RRHandle handle, int n);
1575 
1582 C_DECL_SPEC int rrcCallConv resetCurrentSteadyStateSolverParameters (RRHandle handle);
1583 
1591 C_DECL_SPEC const char* rrcCallConv solverTypeToString (int code);
1592 
1600 
1608 C_DECL_SPEC char* rrcCallConv getCurrentSteadyStateSolverParameterDescription (RRHandle handle, char *parameterName);
1609 
1617 C_DECL_SPEC char* rrcCallConv getCurrentSteadyStateSolverParameterHint (RRHandle handle, char *parameterName);
1618 
1626 C_DECL_SPEC int rrcCallConv getCurrentSteadyStateSolverParameterType (RRHandle handle, char *parameterName);
1627 
1635 C_DECL_SPEC int rrcCallConv getCurrentSteadyStateSolverParameterInt (RRHandle handle, char *parameterName);
1636 
1645 C_DECL_SPEC int rrcCallConv setCurrentSteadyStateSolverParameterInt (RRHandle handle, char *parameterName, int value);
1646 
1654 C_DECL_SPEC unsigned int rrcCallConv getCurrentSteadyStateSolverParameterUInt (RRHandle handle, char *parameterName);
1655 
1664 C_DECL_SPEC int rrcCallConv setCurrentSteadyStateSolverParameterUInt (RRHandle handle, char *parameterName, unsigned int value);
1665 
1673 C_DECL_SPEC double rrcCallConv getCurrentSteadyStateSolverParameterDouble (RRHandle handle, char *parameterName);
1674 
1683 C_DECL_SPEC int rrcCallConv setCurrentSteadyStateSolverParameterDouble (RRHandle handle, char *parameterName, double value);
1684 
1692 C_DECL_SPEC char* rrcCallConv getCurrentSteadyStateSolverParameterString (RRHandle handle, char *parameterName);
1693 
1702 C_DECL_SPEC int rrcCallConv setCurrentSteadyStateSolverParameterString (RRHandle handle, char *parameterName, char* value);
1703 
1711 C_DECL_SPEC int rrcCallConv getCurrentSteadyStateSolverParameterBoolean (RRHandle handle, char *parameterName);
1712 
1721 C_DECL_SPEC int rrcCallConv setCurrentSteadyStateSolverParameterBoolean (RRHandle handle, char *parameterName, int value);
1722 
1723 
1731 C_DECL_SPEC bool rrcCallConv setTimeStart(RRHandle handle, double timeStart);
1732 
1740 C_DECL_SPEC bool rrcCallConv setTimeEnd(RRHandle handle, double timeEnd);
1741 
1749 C_DECL_SPEC bool rrcCallConv setNumPoints(RRHandle handle, int numberOfPoints);
1750 
1751 
1768 C_DECL_SPEC bool rrcCallConv setTimeCourseSelectionList(RRHandle handle, const char* list);
1769 //C_DECL_SPEC bool rrcCallConv setTimeCourseSelectionList(const char* list);
1770 
1778 C_DECL_SPEC RRStringArrayPtr rrcCallConv getTimeCourseSelectionList(RRHandle handle);
1779 
1790 C_DECL_SPEC RRCDataPtr rrcCallConv simulate(RRHandle handle);
1791 
1800 C_DECL_SPEC RRCDataPtr rrcCallConv getSimulationResult(RRHandle handle);
1801 
1802 
1827 C_DECL_SPEC RRCDataPtr rrcCallConv simulateEx(RRHandle handle, const double timeStart, const double timeEnd, const int numberOfPoints);
1828 
1842 C_DECL_SPEC bool rrcCallConv oneStep(RRHandle handle, const double currentTime, const double stepSize, double *value);
1843 
1854 C_DECL_SPEC bool rrcCallConv getTimeStart(RRHandle handle, double* timeStart);
1855 
1866 C_DECL_SPEC bool rrcCallConv getTimeEnd(RRHandle handle, double* timeEnd);
1867 
1878 C_DECL_SPEC bool rrcCallConv getNumPoints (RRHandle handle, int* numPoints);
1879 
1892 C_DECL_SPEC bool rrcCallConv steadyState(RRHandle handle, double* value);
1893 
1904 C_DECL_SPEC RRVectorPtr rrcCallConv computeSteadyStateValues(RRHandle handle);
1905 
1927 C_DECL_SPEC bool rrcCallConv setSteadyStateSelectionList(RRHandle handle, const char* list);
1928 
1937 
1938 
1939 // --------------------------------------------------------------------------------
1940 // Get and Set Routines
1941 // --------------------------------------------------------------------------------
1942 
1954 C_DECL_SPEC bool rrcCallConv getValue(RRHandle handle, const char* symbolId, double* value);
1955 
1956 
1968 C_DECL_SPEC bool rrcCallConv setValue(RRHandle handle, const char* symbolId, const double value);
1969 
1970 
1981 
1982 C_DECL_SPEC RRVectorPtr rrcCallConv getFloatingSpeciesAmounts(RRHandle handle);
1983 
1984 
1995 
1996 C_DECL_SPEC RRVectorPtr rrcCallConv getBoundarySpeciesAmounts(RRHandle handle);
1997 
1998 // --------------------------------------------------------------------------------
1999 // Parameter Group
2000 // --------------------------------------------------------------------------------
2001 
2011 C_DECL_SPEC RRVectorPtr rrcCallConv getGlobalParameterValues(RRHandle handle);
2012 
2022 C_DECL_SPEC bool rrcCallConv setBoundarySpeciesByIndex(RRHandle handle, const unsigned int index, const double value);
2023 
2033 C_DECL_SPEC bool rrcCallConv setFloatingSpeciesInitialConcentrationByIndex(RRHandle handle, int index, double value);
2034 
2044 C_DECL_SPEC bool rrcCallConv getFloatingSpeciesInitialConcentrationByIndex(RRHandle handle, int index, double* value);
2045 
2055 C_DECL_SPEC bool rrcCallConv setFloatingSpeciesByIndex(RRHandle handle, const int index, const double value);
2056 
2066 C_DECL_SPEC bool rrcCallConv setGlobalParameterByIndex(RRHandle handle, const int index, const double value);
2067 
2076 C_DECL_SPEC bool rrcCallConv getBoundarySpeciesByIndex(RRHandle handle, const int index, double* value);
2077 
2087 C_DECL_SPEC bool rrcCallConv getFloatingSpeciesByIndex(RRHandle handle, const int index, double* value);
2088 
2097 C_DECL_SPEC bool rrcCallConv getGlobalParameterByIndex(RRHandle handle, const int index, double* value);
2098 
2108 C_DECL_SPEC bool rrcCallConv getCompartmentByIndex (RRHandle handle, const int index, double* value);
2109 
2110 
2120 C_DECL_SPEC bool rrcCallConv setCompartmentByIndex (RRHandle handle, const int index, const double value);
2121 
2122 
2141 C_DECL_SPEC bool rrcCallConv setFloatingSpeciesConcentrations(RRHandle handle, const RRVectorPtr vec);
2142 
2161 C_DECL_SPEC bool rrcCallConv setBoundarySpeciesConcentrations(RRHandle handle, const RRVectorPtr vec);
2162 
2163 
2171 C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getFullJacobian(RRHandle handle);
2172 
2182 C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getReducedJacobian(RRHandle handle);
2183 
2191 C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getEigenvalues(RRHandle handle);
2192 
2193 
2194 // --------------------------------------------------------------------------------
2195 // Stoichiometry methods
2196 // --------------------------------------------------------------------------------
2197 
2205 C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getStoichiometryMatrix(RRHandle handle);
2206 
2214 C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getLinkMatrix(RRHandle handle);
2215 
2223 C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getNrMatrix(RRHandle handle);
2224 
2234 C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getConservationMatrix(RRHandle handle);
2235 
2236 // --------------------------------------------------------------------------------
2237 // Initial condition Methods
2238 // --------------------------------------------------------------------------------
2239 
2250 C_DECL_SPEC bool rrcCallConv setFloatingSpeciesInitialConcentrations (RRHandle handle, const RRVectorPtr vec);
2251 
2262 
2274 
2285 
2286 
2287 // --------------------------------------------------------------------------------
2288 // Reaction rates
2289 // --------------------------------------------------------------------------------
2290 
2300 C_DECL_SPEC int rrcCallConv getNumberOfReactions(RRHandle handle);
2301 
2302 
2312 C_DECL_SPEC bool rrcCallConv getReactionRate(RRHandle handle, const int index, double* rate);
2313 
2314 
2322 C_DECL_SPEC RRVectorPtr rrcCallConv getReactionRates(RRHandle handle);
2323 
2324 
2333 C_DECL_SPEC RRVectorPtr rrcCallConv getReactionRatesEx (RRHandle handle, const RRVectorPtr vec);
2334 
2335 
2345 C_DECL_SPEC RRVectorPtr rrcCallConv getRatesOfChange(RRHandle handle);
2346 
2356 C_DECL_SPEC RRStringArrayPtr rrcCallConv getRatesOfChangeIds(RRHandle handle);
2357 
2358 
2369 C_DECL_SPEC bool rrcCallConv getRateOfChange(RRHandle handle, const int, double* value);
2370 
2371 
2382 C_DECL_SPEC RRVectorPtr rrcCallConv getRatesOfChangeEx (RRHandle handle, const RRVectorPtr vec);
2383 
2391 C_DECL_SPEC bool rrcCallConv evalModel(RRHandle handle);
2392 
2393 // Get number family
2400 C_DECL_SPEC int rrcCallConv getNumberOfCompartments (RRHandle handle);
2401 
2402 
2408 C_DECL_SPEC int rrcCallConv getNumberOfBoundarySpecies(RRHandle handle);
2409 
2410 
2416 C_DECL_SPEC int rrcCallConv getNumberOfFloatingSpecies(RRHandle handle);
2417 
2418 
2424 C_DECL_SPEC int rrcCallConv getNumberOfGlobalParameters(RRHandle handle);
2425 
2426 // --------------------------------------------------------------------------------
2427 // Get number family
2428 // --------------------------------------------------------------------------------
2429 
2435 C_DECL_SPEC int rrcCallConv getNumberOfDependentSpecies(RRHandle handle);
2436 
2437 
2444 C_DECL_SPEC int rrcCallConv getNumberOfIndependentSpecies(RRHandle handle);
2445 
2446 // --------------------------------------------------------------------------------
2447 // Get Ids family
2448 // --------------------------------------------------------------------------------
2449 
2457 C_DECL_SPEC RRStringArrayPtr rrcCallConv getReactionIds(RRHandle handle);
2458 
2466 C_DECL_SPEC RRStringArrayPtr rrcCallConv getBoundarySpeciesIds(RRHandle handle);
2467 
2468 
2477 
2485 C_DECL_SPEC RRStringArrayPtr rrcCallConv getFloatingSpeciesIds(RRHandle handle);
2486 
2487 
2488 
2489 C_DECL_SPEC RRStringArrayPtr rrcCallConv getDependentFloatingSpeciesIds(RRHandle handle);
2490 
2491 
2500 
2501 
2509 C_DECL_SPEC RRStringArrayPtr rrcCallConv getGlobalParameterIds(RRHandle handle);
2510 
2520 C_DECL_SPEC RRStringArrayPtr rrcCallConv getCompartmentIds(RRHandle handle);
2521 
2529 C_DECL_SPEC RRStringArrayPtr rrcCallConv getEigenvalueIds(RRHandle handle);
2530 
2538 C_DECL_SPEC RRListPtr rrcCallConv getAvailableTimeCourseSymbols(RRHandle handle);
2539 
2547 C_DECL_SPEC RRListPtr rrcCallConv getAvailableSteadyStateSymbols(RRHandle handle);
2548 
2549 // --------------------------------------------------------------------------------
2550 // MCA methods
2551 // --------------------------------------------------------------------------------
2552 
2560 C_DECL_SPEC RRListPtr rrcCallConv getElasticityCoefficientIds(RRHandle handle);
2561 
2570 
2578 C_DECL_SPEC RRListPtr rrcCallConv getFluxControlCoefficientIds(RRHandle handle);
2579 
2588 
2597 
2606 
2614 C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getScaledElasticityMatrix(RRHandle handle);
2615 
2616 
2627 C_DECL_SPEC bool rrcCallConv getScaledFloatingSpeciesElasticity(RRHandle handle, const char* reactionId, const char* speciesId, double* value);
2628 
2638 
2639 
2648 
2657 
2666 
2677 C_DECL_SPEC bool rrcCallConv getuCC (RRHandle handle, const char* variable, const char* parameter, double* value);
2678 
2689 C_DECL_SPEC bool rrcCallConv getCC (RRHandle handle, const char* variable, const char* parameter, double* value);
2690 
2701 C_DECL_SPEC bool rrcCallConv getEE(RRHandle handle, const char* name, const char* species, double* value);
2702 
2713 C_DECL_SPEC bool rrcCallConv getuEE(RRHandle handle, const char* name, const char* species, double* value);
2714 
2715 // --------------------------------------------------------------------------------
2716 // Stochastic methods
2717 // --------------------------------------------------------------------------------
2718 
2727 C_DECL_SPEC bool rrcCallConv getSeed(RRHandle handle, long* seed);
2728 
2737 C_DECL_SPEC bool rrcCallConv setSeed(RRHandle handle, long seed);
2738 
2750 C_DECL_SPEC RRCDataPtr rrcCallConv gillespie(RRHandle handle);
2751 
2774 C_DECL_SPEC RRCDataPtr rrcCallConv gillespieEx(RRHandle handle, double timeStart, double timeEnd);
2775 
2787 C_DECL_SPEC RRCDataPtr rrcCallConv gillespieOnGrid(RRHandle handle);
2788 
2814 C_DECL_SPEC RRCDataPtr rrcCallConv gillespieOnGridEx(RRHandle handle, double timeStart, double timeEnd, int numberOfPoints);
2815 
2829 C_DECL_SPEC RRCDataPtr rrcCallConv gillespieMeanOnGrid(RRHandle handle, int numberOfSimulations);
2830 
2858 C_DECL_SPEC RRCDataPtr rrcCallConv gillespieMeanOnGridEx(RRHandle handle, double timeStart, double timeEnd, int numberOfPoints, int numberOfSimulations);
2859 
2874 C_DECL_SPEC RRCDataPtr rrcCallConv gillespieMeanSDOnGrid(RRHandle handle, int numberOfSimulations);
2875 
2876 
2906 C_DECL_SPEC RRCDataPtr rrcCallConv gillespieMeanSDOnGridEx(RRHandle handle, double timeStart, double timeEnd, int numberOfSteps, int numberOfSimulations);
2907 
2908 // --------------------------------------------------------------------------------
2909 // Reset methods
2910 // --------------------------------------------------------------------------------
2911 
2920 C_DECL_SPEC bool rrcCallConv reset(RRHandle handle);
2921 
2930 C_DECL_SPEC bool rrcCallConv resetAll(RRHandle handle);
2931 
2940 C_DECL_SPEC bool rrcCallConv resetToOrigin(RRHandle handle);
2941 
2949 C_DECL_SPEC bool rrcCallConv resetParameter(RRHandle handle);
2950 
2959 C_DECL_SPEC int rrcCallConv setConfigBool(const char* key, int value);
2960 
2968 C_DECL_SPEC int rrcCallConv getConfigBool(const char* key);
2969 
2978 C_DECL_SPEC int rrcCallConv setConfigInt(const char* key, int value);
2979 
2987 C_DECL_SPEC int rrcCallConv getConfigInt(const char* key);
2988 
2997 C_DECL_SPEC int rrcCallConv setConfigDouble(const char* key, double value);
2998 
2999 
3000 //RRPlugins
3005 C_DECL_SPEC int rrcCallConv _getNumIndFloatingSpecies(RRHandle handle);
3006 
3010 C_DECL_SPEC int rrcCallConv _getNumRateRules(RRHandle handle);
3011 
3015 C_DECL_SPEC double rrcCallConv _getTime(RRHandle handle);
3016 
3020 C_DECL_SPEC int rrcCallConv _getStateVector(RRHandle handle);
3021 
3025 C_DECL_SPEC void rrcCallConv _getStateVectorRate(RRHandle handle,double time, double *value);
3026 
3027 
3035 C_DECL_SPEC double rrcCallConv getConfigDouble(const char* key);
3036 
3042 C_DECL_SPEC RRStringArrayPtr rrcCallConv getListOfConfigKeys();
3043 
3044 #if defined( __cplusplus)
3045 }
3046 }//namespace
3047 
3048 #endif
3049 
3050 #endif
C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getReducedJacobian(RRHandle handle)
Retrieve the reduced Jacobian for the current model.
C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getStoichiometryMatrix(RRHandle handle)
Retrieve the stoichiometry matrix for the current model.
C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getEigenvalues(RRHandle handle)
Retrieve the eigenvalue matrix for the current model.
C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getFullJacobian(RRHandle handle)
Retrieve the full Jacobian for the current model.
C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getNrMatrix(RRHandle handle)
Retrieve the reduced stoichiometry matrix for the current model.
C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getConservationMatrix(RRHandle handle)
Retrieve the conservation matrix for the current model.
C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getLinkMatrix(RRHandle handle)
Retrieve the Link matrix for the current model.
C_DECL_SPEC bool rrcCallConv setBoundarySpeciesByIndex(RRHandle handle, const unsigned int index, const double value)
Set the concentration for a particular boundary species.
C_DECL_SPEC RRStringArrayPtr rrcCallConv getBoundarySpeciesConcentrationIds(RRHandle handle)
Obtain the list of boundary species concentration Ids.
C_DECL_SPEC RRStringArrayPtr rrcCallConv getBoundarySpeciesIds(RRHandle handle)
Obtain the list of boundary species Ids.
C_DECL_SPEC bool rrcCallConv getBoundarySpeciesByIndex(RRHandle handle, const int index, double *value)
Retrieve the concentration for a particular floating species.
C_DECL_SPEC int rrcCallConv getNumberOfBoundarySpecies(RRHandle handle)
Returns the number of boundary species in the model.
C_DECL_SPEC RRVectorPtr rrcCallConv getBoundarySpeciesConcentrations(RRHandle handle)
Retrieve the concentrations for all the boundary species in a vector.
C_DECL_SPEC bool rrcCallConv setBoundarySpeciesConcentrations(RRHandle handle, const RRVectorPtr vec)
Set the boundary species concentration to the vector vec.
C_DECL_SPEC RRStringArrayPtr rrcCallConv getCompartmentIds(RRHandle handle)
Obtain the list of compartment Ids.
C_DECL_SPEC bool rrcCallConv getCompartmentByIndex(RRHandle handle, const int index, double *value)
Retrieve the compartment volume for a particular compartment.
C_DECL_SPEC bool rrcCallConv setCompartmentByIndex(RRHandle handle, const int index, const double value)
Set the volume for a particular compartment.
C_DECL_SPEC int rrcCallConv getNumberOfCompartments(RRHandle handle)
Returns the number of compartments in the model.
C_DECL_SPEC int rrcCallConv getConfigBool(const char *key)
Get a boolean configuration value.
C_DECL_SPEC int rrcCallConv setConfigBool(const char *key, int value)
Set a boolean configuration value.
C_DECL_SPEC double rrcCallConv getConfigDouble(const char *key)
Get a double configuration value.
C_DECL_SPEC int rrcCallConv setConfigInt(const char *key, int value)
Set an integer configuration value.
C_DECL_SPEC int rrcCallConv setConfigDouble(const char *key, double value)
Set a double configuration value.
C_DECL_SPEC int rrcCallConv getConfigInt(const char *key)
Get an integer configuration value.
C_DECL_SPEC RRStringArrayPtr rrcCallConv getListOfConfigKeys()
Get a list of all possible config keys.
C_DECL_SPEC bool rrcCallConv removeEventAssignments(RRHandle handle, const char *eid, const char *vid)
Remove event assignments for given variable from an existing event.
C_DECL_SPEC bool rrcCallConv removeParameterNoRegen(RRHandle handle, const char *pid)
Remove a parameter from the current model, without regenerating it The last modification must regener...
C_DECL_SPEC bool rrcCallConv setKineticLawNoRegen(RRHandle handle, const char *rid, const char *kineticLaw)
Set the kinetic law for a existing reaction in the current model, without regenerating it The last mo...
C_DECL_SPEC bool rrcCallConv addAssignmentRuleNoRegen(RRHandle handle, const char *vid, const char *formula)
Add an assignment rule to the current model, without regenerating it The last modification must regen...
C_DECL_SPEC bool rrcCallConv removeReaction(RRHandle handle, const char *rid)
Remove a reaction from the current model.
C_DECL_SPEC bool rrcCallConv removeEventAssignmentsNoRegen(RRHandle handle, const char *eid, const char *vid)
Remove event assignments for given variable from an existing event, without regenerating it The last ...
C_DECL_SPEC bool rrcCallConv addReactionNoRegen(RRHandle handle, const char *rid, const char **reactants, int numReactants, const char **products, int numProducts, const char *kineticLaw)
Add a reaction to the current model, without regenerating it The last modification must regenerate fo...
C_DECL_SPEC bool rrcCallConv setHasOnlySubstanceUnits(RRHandle handle, const char *sid, bool hasOnlySubstanceUnits)
Set the hasOnlySubstanceUnits attribute for an existing species.
C_DECL_SPEC bool rrcCallConv addReactionFromSBML(RRHandle handle, const char *sbmlRep)
Add a reaction to the current model.
C_DECL_SPEC bool rrcCallConv setReversible(RRHandle handle, const char *rid, bool reversible)
Set the reversible attribut for an existing reaction in the current model.
C_DECL_SPEC bool rrcCallConv removeEventsNoRegen(RRHandle handle, const char *eid)
Remove an event from the current model, without regenerating it The last modification must regenerate...
C_DECL_SPEC bool rrcCallConv addSpeciesNoRegen(RRHandle handle, const char *sid, const char *compartment, double initialAmount, bool hasOnlySubstanceUnits, bool boundaryCondition)
Add a species to the current model, without regenerating it The last modification must regenerate for...
C_DECL_SPEC bool rrcCallConv setReversibleNoRegen(RRHandle handle, const char *rid, bool reversible)
Set the reversible attribut for an existing reaction in the current model, without regenerating it Th...
C_DECL_SPEC bool rrcCallConv removeRulesNoRegen(RRHandle handle, const char *vid)
Remove rules related to given variable from the current model, without regenerating it The last modif...
C_DECL_SPEC bool rrcCallConv addDelayNoRegen(RRHandle handle, const char *eid, const char *delay)
Add delay to an existing event in the model, without regenerating it The last modification must regen...
C_DECL_SPEC bool rrcCallConv addEvent(RRHandle handle, const char *eid, bool useValuesFromTriggerTime, const char *trigger)
Add an event to the current model.
C_DECL_SPEC bool rrcCallConv addEventAssignmentNoRegen(RRHandle handle, const char *eid, const char *vid, const char *formula)
Add an event assignment to an existing event in the current model, without regenerating it The last m...
C_DECL_SPEC bool rrcCallConv addPriorityNoRegen(RRHandle handle, const char *eid, const char *priority)
Add priority to an existing event in the model, without regenerating it The last modification must re...
C_DECL_SPEC bool rrcCallConv removeReactionNoRegen(RRHandle handle, const char *rid)
Remove a reaction from the current model, without regenerating it The last modification must regenera...
C_DECL_SPEC bool rrcCallConv addTriggerNoRegen(RRHandle handle, const char *eid, const char *trigger)
Add trigger to an existing event in the model, without regenerating it The last modification must reg...
C_DECL_SPEC bool rrcCallConv addParameterNoRegen(RRHandle handle, const char *pid, double value)
Add a parameter to the current model, without regenerating it The last modification must regenerate f...
C_DECL_SPEC bool rrcCallConv setInitConcentration(RRHandle handle, const char *sid, double initConcentration)
Set initial concentration for an existing species. Initial amount/concentration set before will be un...
C_DECL_SPEC bool rrcCallConv setPersistent(RRHandle handle, const char *eid, bool persistent)
Set the persistent attribute of the trigger of given event.
C_DECL_SPEC bool rrcCallConv validateCurrentSBML(RRHandle handle)
Validate the current SBML file.
C_DECL_SPEC bool rrcCallConv setKineticLaw(RRHandle handle, const char *rid, const char *kineticLaw)
Set the kinetic law for a existing reaction in the current model.
C_DECL_SPEC bool rrcCallConv setConstant(RRHandle handle, const char *sid, bool constant)
Set the constant attribute for an existing species/ parameter/ compartment.
C_DECL_SPEC bool rrcCallConv addRateRule(RRHandle handle, const char *vid, const char *formula)
Add a rate rule to the current model.
C_DECL_SPEC bool rrcCallConv setConstantNoRegen(RRHandle handle, const char *sid, bool constant)
Set the constant attribute for an existing species/ parameter/ compartment, without regenerating it T...
C_DECL_SPEC bool rrcCallConv addPriority(RRHandle handle, const char *eid, const char *priority)
Add priority to an existing event in the model If the given event already has a priority object,...
C_DECL_SPEC bool rrcCallConv addCompartment(RRHandle handle, const char *cid, double initVolume)
Add a compartment to the current model.
C_DECL_SPEC bool rrcCallConv addSpecies(RRHandle handle, const char *sid, const char *compartment, double initialAmount, bool hasOnlySubstanceUnits, bool boundaryCondition)
Add a species to the current model.
C_DECL_SPEC bool rrcCallConv setInitAmountNoRegen(RRHandle handle, const char *sid, double initAmount)
Set initial amount for an existing species, without regenerating it The last modification must regene...
C_DECL_SPEC bool rrcCallConv setTriggerInitialValueNoRegen(RRHandle handle, const char *eid, bool initValue)
Set the initial value attribute of the trigger of given event, without regenerating it The last modif...
C_DECL_SPEC bool rrcCallConv setBoundary(RRHandle handle, const char *sid, bool boundaryCondition)
Set the boundary condition of an existing species.
C_DECL_SPEC bool rrcCallConv addEventNoRegen(RRHandle handle, const char *eid, bool useValuesFromTriggerTime, const char *trigger)
Add an event to the current model, without regenerating it The last modification must regenerate for ...
C_DECL_SPEC bool rrcCallConv setInitAmount(RRHandle handle, const char *sid, double initAmount)
Set initial amount for an existing species. Initial amount/concentration set before will be unset.
C_DECL_SPEC bool rrcCallConv setHasOnlySubstanceUnitsNoRegen(RRHandle handle, const char *sid, bool hasOnlySubstanceUnits)
Set the hasOnlySubstanceUnits attribute for an existing species, without regenerating it The last mod...
C_DECL_SPEC bool rrcCallConv addEventAssignment(RRHandle handle, const char *eid, const char *vid, const char *formula)
Add an event assignment to an existing event in the current model.
C_DECL_SPEC bool rrcCallConv removeSpeciesNoRegen(RRHandle handle, const char *sid)
Remove a species from the current model, without regenerating it The last modification must regenerat...
C_DECL_SPEC bool rrcCallConv addReaction(RRHandle handle, const char *rid, const char **reactants, int numReactants, const char **products, int numProducts, const char *kineticLaw)
Add a reaction to the current model.
C_DECL_SPEC bool rrcCallConv addRateRuleNoRegen(RRHandle handle, const char *vid, const char *formula)
Add a rate rule to the current model, without regenerating it The last modification must regenerate f...
C_DECL_SPEC bool rrcCallConv addTrigger(RRHandle handle, const char *eid, const char *trigger)
Add trigger to an existing event in the model If the given event already has a trigger object,...
C_DECL_SPEC bool rrcCallConv setBoundaryNoRegen(RRHandle handle, const char *sid, bool boundaryCondition)
Set the boundary condition of an existing species, without regenerating it The last modification must...
C_DECL_SPEC bool rrcCallConv addCompartmentNoRegen(RRHandle handle, const char *cid, double initVolume)
Add a compartment to the current model, without regenerating it The last modification must regenerate...
C_DECL_SPEC bool rrcCallConv addAssignmentRule(RRHandle handle, const char *vid, const char *formula)
Add an assignment rule to the current model.
C_DECL_SPEC bool rrcCallConv removeParameter(RRHandle handle, const char *pid)
Remove a parameter from the current model.
C_DECL_SPEC bool rrcCallConv removeRules(RRHandle handle, const char *vid)
Remove rules related to given variable from the current model.
C_DECL_SPEC bool rrcCallConv setTriggerInitialValue(RRHandle handle, const char *eid, bool initValue)
Set the initial value attribute of the trigger of given event.
C_DECL_SPEC bool rrcCallConv addParameter(RRHandle handle, const char *pid, double value)
Add a parameter to the current model.
C_DECL_SPEC bool rrcCallConv addDelay(RRHandle handle, const char *eid, const char *delay)
Add delay to an existing event in the model If the given event already has a delay object,...
C_DECL_SPEC bool rrcCallConv addReactionFromSBMLNoRegen(RRHandle handle, const char *sbmlRep)
Add a reaction to the current model, without regenerating it The last modification must regenerate fo...
C_DECL_SPEC char *rrcCallConv getKineticLaw(RRHandle handle, const char *rid)
Get the kinetic law for a existing reaction in the current model.
C_DECL_SPEC bool rrcCallConv setInitConcentrationNoRegen(RRHandle handle, const char *sid, double initConcentration)
Set initial concentration for an existing species, without regenerating it The last modification must...
C_DECL_SPEC bool rrcCallConv setPersistentNoRegen(RRHandle handle, const char *eid, bool persistent)
Set the persistent attribute of the trigger of given event, without regenerating it The last modifica...
C_DECL_SPEC bool rrcCallConv removeSpecies(RRHandle handle, const char *sid)
Remove a species from the current model.
C_DECL_SPEC bool rrcCallConv removeCompartment(RRHandle handle, const char *cid)
Remove a compartment from the current model.
C_DECL_SPEC bool rrcCallConv removeEvent(RRHandle handle, const char *eid)
Remove an event from the current model.
C_DECL_SPEC bool rrcCallConv removeCompartmentNoRegen(RRHandle handle, const char *cid)
Remove a compartment from the current model, without regenerating it The last modification must regen...
C_DECL_SPEC bool rrcCallConv hasError(void)
Check if there is an error string to retrieve.
C_DECL_SPEC char *rrcCallConv getLastError(void)
Retrieve the current error string.
C_DECL_SPEC RRVectorPtr rrcCallConv getFloatingSpeciesConcentrations(RRHandle handle)
Retrieve in a vector the concentrations for all the floating species.
C_DECL_SPEC bool rrcCallConv setFloatingSpeciesInitialConcentrationByIndex(RRHandle handle, int index, double value)
Set the initial concentration for a particular floating species.
C_DECL_SPEC int rrcCallConv getNumberOfDependentSpecies(RRHandle handle)
Returns the number of dependent species in the model.
C_DECL_SPEC bool rrcCallConv getFloatingSpeciesInitialConcentrationByIndex(RRHandle handle, int index, double *value)
Get the initial concentration for a particular floating species.
C_DECL_SPEC bool rrcCallConv setFloatingSpeciesByIndex(RRHandle handle, const int index, const double value)
Set the concentration for a particular floating species.
C_DECL_SPEC bool rrcCallConv getFloatingSpeciesByIndex(RRHandle handle, const int index, double *value)
Retrieve the concentration for a particular floating species.
C_DECL_SPEC int rrcCallConv getNumberOfFloatingSpecies(RRHandle handle)
Returns the number of floating species in the model.
C_DECL_SPEC bool rrcCallConv setFloatingSpeciesConcentrations(RRHandle handle, const RRVectorPtr vec)
Set the floating species concentration to the vector vec.
C_DECL_SPEC RRStringArrayPtr rrcCallConv getFloatingSpeciesIds(RRHandle handle)
Obtain the list of floating species Id.
C_DECL_SPEC RRStringArrayPtr rrcCallConv getFloatingSpeciesConcentrationIds(RRHandle handle)
Obtain the list of floating species concentrations Id.
C_DECL_SPEC int rrcCallConv getNumberOfIndependentSpecies(RRHandle handle)
Returns the number of independent species in the model.
C_DECL_SPEC RRStringArrayPtr rrcCallConv getFloatingSpeciesInitialConditionIds(RRHandle handle)
Get the initial floating species Ids.
C_DECL_SPEC RRStringArrayPtr rrcCallConv getFloatingSpeciesInitialConcentrationIds(RRHandle handle)
Get the initial floating species Ids.
C_DECL_SPEC bool rrcCallConv setFloatingSpeciesInitialConcentrations(RRHandle handle, const RRVectorPtr vec)
Set the initial floating species concentrations.
C_DECL_SPEC RRVectorPtr rrcCallConv getFloatingSpeciesInitialConcentrations(RRHandle handle)
Get the initial floating species concentrations.
C_DECL_SPEC RRHandle rrcCallConv createRRInstanceEx(const char *tempFolder, const char *compiler)
Initialize a new roadRunner instance and return a handle to it.
C_DECL_SPEC RRHandle rrcCallConv createRRInstance(void)
Initialize a new roadRunner instance and return a handle to it.
C_DECL_SPEC int rrcCallConv getComputeAndAssignConservationLaws(RRHandle handle, int *value)
Get the value of the moiety conservation setting.
C_DECL_SPEC bool rrcCallConv setInstallFolder(const char *folder)
Set the internal string containing the folder in where the RoadRunner C wrappers is installed.
C_DECL_SPEC bool rrcCallConv setComputeAndAssignConservationLaws(RRHandle handle, const bool On_Or_Off)
Enable or disable conservation analysis.
char * getInstallFolder(void)
Returns the folder in which the RoadRunner wrappers is installed.
C_DECL_SPEC bool rrcCallConv freeRRInstance(RRHandle handle)
Free the roadRunner instance.
C_DECL_SPEC bool rrcCallConv loadSBMLFromFile(RRHandle handle, const char *fileName)
Load a model from a SBML file.
C_DECL_SPEC bool rrcCallConv isModelLoaded(RRHandle handle)
check if a model is loaded
C_DECL_SPEC bool rrcCallConv loadSBMLEx(RRHandle handle, const char *sbml, bool forceRecompile)
Load a model from an SBML string.
C_DECL_SPEC bool rrcCallConv loadSimulationSettings(RRHandle handle, const char *fileName)
Load simulation settings from a file.
C_DECL_SPEC char *rrcCallConv getSBML(RRHandle handle)
Retrieve the SBML model that was last loaded into roadRunner.
C_DECL_SPEC bool rrcCallConv loadState(RRHandle handle, const char *filename)
Reload a road runner instance's state saved by saveState.
C_DECL_SPEC bool rrcCallConv loadSBMLFromFileE(RRHandle handle, const char *fileName, bool forceRecompile)
Load a model from a SBML file, force recompilation.
C_DECL_SPEC bool rrcCallConv clearModel(RRHandle handle)
Unload current model.
C_DECL_SPEC char *rrcCallConv getCurrentSBML(RRHandle handle)
Retrieve the current state of the model in the form of an SBML string.
C_DECL_SPEC bool rrcCallConv saveState(RRHandle handle, const char *filename)
Save a road runner instance's state to a platform-specific binary file.
C_DECL_SPEC bool rrcCallConv loadSBML(RRHandle handle, const char *sbml)
Load a model from an SBML string.
C_DECL_SPEC bool rrcCallConv getuEE(RRHandle handle, const char *name, const char *species, double *value)
Retrieve a single unscaled elasticity coefficient.
C_DECL_SPEC bool rrcCallConv getCC(RRHandle handle, const char *variable, const char *parameter, double *value)
Retrieve a single control coefficient.
C_DECL_SPEC bool rrcCallConv getEE(RRHandle handle, const char *name, const char *species, double *value)
Retrieve a single elasticity coefficient.
C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getUnscaledElasticityMatrix(RRHandle handle)
Retrieve the unscaled elasticity matrix for the current model.
C_DECL_SPEC RRListPtr rrcCallConv getFluxControlCoefficientIds(RRHandle handle)
Obtain the list of flux control coefficient Ids.
C_DECL_SPEC RRListPtr rrcCallConv getElasticityCoefficientIds(RRHandle handle)
Obtain the list of elasticity coefficient Ids.
C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getScaledElasticityMatrix(RRHandle handle)
Retrieve the scaled elasticity matrix for the current model.
C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getUnscaledFluxControlCoefficientMatrix(RRHandle handle)
Retrieve the matrix of unscaled flux control coefficients for the current model.
C_DECL_SPEC RRListPtr rrcCallConv getConcentrationControlCoefficientIds(RRHandle handle)
Obtain the list of concentration coefficient Ids.
C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getScaledFluxControlCoefficientMatrix(RRHandle handle)
Retrieve the matrix of scaled flux control coefficients for the current model.
C_DECL_SPEC RRListPtr rrcCallConv getUnscaledConcentrationControlCoefficientIds(RRHandle handle)
Obtain the list of unscaled concentration control coefficient Ids.
C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getUnscaledConcentrationControlCoefficientMatrix(RRHandle handle)
Retrieve the matrix of unscaled concentration control coefficients for the current model.
C_DECL_SPEC RRListPtr rrcCallConv getUnscaledFluxControlCoefficientIds(RRHandle handle)
Obtain the list of unscaled flux control coefficient Ids.
C_DECL_SPEC bool rrcCallConv getScaledFloatingSpeciesElasticity(RRHandle handle, const char *reactionId, const char *speciesId, double *value)
Retrieve the scaled elasticity matrix for the current model.
C_DECL_SPEC bool rrcCallConv getuCC(RRHandle handle, const char *variable, const char *parameter, double *value)
Retrieve a single unscaled control coefficient.
C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv getScaledConcentrationControlCoefficientMatrix(RRHandle handle)
Retrieve the matrix of scaled concentration control coefficients for the current model.
C_DECL_SPEC RRStringArrayPtr rrcCallConv getGlobalParameterIds(RRHandle handle)
Obtain the list of global parameter Ids.
C_DECL_SPEC bool rrcCallConv setGlobalParameterByIndex(RRHandle handle, const int index, const double value)
Set the value for a particular global parameter.
C_DECL_SPEC int rrcCallConv getNumberOfGlobalParameters(RRHandle handle)
Returns the number of global parameters in the model.
C_DECL_SPEC RRVectorPtr rrcCallConv getGlobalParameterValues(RRHandle handle)
Retrieve the values for all the global parameter values in a vector.
C_DECL_SPEC bool rrcCallConv getGlobalParameterByIndex(RRHandle handle, const int index, double *value)
Retrieve the global parameter value.
C_DECL_SPEC RRVectorPtr rrcCallConv getRatesOfChangeEx(RRHandle handle, const RRVectorPtr vec)
Retrieve the vector of rates of change given a vector of floating species concentrations.
C_DECL_SPEC RRStringArrayPtr rrcCallConv getRatesOfChangeIds(RRHandle handle)
Retrieve the string list of rates of change Ids.
C_DECL_SPEC bool rrcCallConv getRateOfChange(RRHandle handle, const int, double *value)
Retrieve the rate of change for a given floating species.
C_DECL_SPEC RRVectorPtr rrcCallConv getRatesOfChange(RRHandle handle)
Retrieve the vector of rates of change as determined by the current state of the model.
C_DECL_SPEC RRVectorPtr rrcCallConv getReactionRatesEx(RRHandle handle, const RRVectorPtr vec)
Retrieve a vector of reaction rates given a vector of species concentrations.
C_DECL_SPEC bool rrcCallConv getReactionRate(RRHandle handle, const int index, double *rate)
Retrieve a give reaction rate as indicated by the index parameter.
C_DECL_SPEC RRStringArrayPtr rrcCallConv getReactionIds(RRHandle handle)
Obtain the list of reaction Ids.
C_DECL_SPEC int rrcCallConv getNumberOfReactions(RRHandle handle)
Obtain the number of reactions in the loaded model.
C_DECL_SPEC RRVectorPtr rrcCallConv getReactionRates(RRHandle handle)
Retrieve a vector of reaction rates as determined by the current state of the model.
C_DECL_SPEC bool rrcCallConv resetToOrigin(RRHandle handle)
Resets the model to the state in which it was first loaded, including initial conditions,...
C_DECL_SPEC bool rrcCallConv resetAll(RRHandle handle)
Resets all variables of the model to their current initial values, and resets all parameters to their...
C_DECL_SPEC bool rrcCallConv reset(RRHandle handle)
Resets all variables of the model to their current initial values. Does not change the parameters.
C_DECL_SPEC bool rrcCallConv resetParameter(RRHandle handle)
Resets all parameters of the model to their current initial values.
C_DECL_SPEC char *rrcCallConv getCurrentIntegratorNthParameterHint(RRHandle handle, int n)
Get the hint of a parameter of the current integrator.
C_DECL_SPEC int rrcCallConv getCurrentSteadyStateSolverParameterInt(RRHandle handle, char *parameterName)
Get the integer value for a specific steady state solver setting.
C_DECL_SPEC unsigned int rrcCallConv getCurrentIntegratorParameterUInt(RRHandle handle, char *parameterName)
Get the unsigned integer value for a specific integrator setting.
C_DECL_SPEC char *rrcCallConv getCurrentSteadyStateSolverNthParameterDescription(RRHandle handle, int n)
Get the description of a parameter of the current steady state solver.
C_DECL_SPEC int rrcCallConv setCurrentIntegratorIndividualTolerance(RRHandle handle, char *sid, double value)
Set the double array value for a specific integrator setting. Should only used for absoluate tolerace...
C_DECL_SPEC double rrcCallConv getCurrentIntegratorParameterDouble(RRHandle handle, char *parameterName)
Get the double value for a specific integrator setting.
C_DECL_SPEC int rrcCallConv getCurrentSteadyStateSolverParameterType(RRHandle handle, char *parameterName)
Get the return type for a specific steady state solver setting.
C_DECL_SPEC int rrcCallConv setCurrentIntegratorParameterBoolean(RRHandle handle, char *parameterName, int value)
Set the boolean value for a specific integrator setting.
C_DECL_SPEC int rrcCallConv resetCurrentIntegratorParameters(RRHandle handle)
Reset the integrator parameters to their default values.
C_DECL_SPEC int rrcCallConv getNumberOfCurrentSteadyStateSolverParameters(RRHandle handle)
Get the number of adjustable settings for the current steady state solver.
C_DECL_SPEC int rrcCallConv setCurrentIntegratorParameterInt(RRHandle handle, char *parameterName, int value)
Set the integer value for a specific integrator setting.
C_DECL_SPEC int rrcCallConv setCurrentSteadyStateSolverParameterInt(RRHandle handle, char *parameterName, int value)
Set the integer value for a specific steady state solver setting.
C_DECL_SPEC int rrcCallConv getCurrentIntegratorParameterDoubleArray(RRHandle handle, char *parameterName, double **value, int *len)
Get the double array value for a specific integrator setting. Should only used for absoluate tolerace...
C_DECL_SPEC char *rrcCallConv getRegisteredSteadyStateSolverDescription(int n)
Get the description of a registered steady state solver (e.g. cvode etc.)
C_DECL_SPEC int rrcCallConv resetCurrentSteadyStateSolverParameters(RRHandle handle)
Reset the steady state solver parameters to their default values.
C_DECL_SPEC int rrcCallConv getCurrentIntegratorNthParameterType(RRHandle handle, int n)
Get the type of a parameter of the current integrator.
C_DECL_SPEC RRStringArrayPtr rrcCallConv getListOfCurrentIntegratorParameterNames(RRHandle handle)
Get the names of adjustable settings for the current integrator.
C_DECL_SPEC char *rrcCallConv getCurrentIntegratorParameterHint(RRHandle handle, char *parameterName)
Get the hint for a specific integrator setting.
C_DECL_SPEC char *rrcCallConv getCurrentSteadyStateSolverNthParameterHint(RRHandle handle, int n)
Get the hint of a parameter of the current steady state solver.
C_DECL_SPEC int rrcCallConv getCurrentIntegratorParameterBoolean(RRHandle handle, char *parameterName)
Get the boolean value for a specific integrator setting.
C_DECL_SPEC char *rrcCallConv getCurrentSteadyStateSolverHint(RRHandle handle)
Obtain a short hint for the current steady state solver.
C_DECL_SPEC char *rrcCallConv getRegisteredSteadyStateSolverHint(int n)
Get the hint of a registered steady state solver (e.g. cvode etc.)
C_DECL_SPEC int rrcCallConv setCurrentSteadyStateSolverParameterString(RRHandle handle, char *parameterName, char *value)
Set the string value for a specific steady state solver setting.
C_DECL_SPEC char *rrcCallConv getCurrentIntegratorHint(RRHandle handle)
Obtain a short hint for the current integrator.
C_DECL_SPEC const char *rrcCallConv solverTypeToString(int code)
Get a string description of the type [STATIC MEMORY - DO NOT FREE] \description Can call on return va...
C_DECL_SPEC char *rrcCallConv getCurrentSteadyStateSolverParameterString(RRHandle handle, char *parameterName)
Get the string value for a specific steady state solver setting.
C_DECL_SPEC int rrcCallConv getCurrentIntegratorParameterInt(RRHandle handle, char *parameterName)
Get the integer value for a specific integrator setting.
C_DECL_SPEC int rrcCallConv setCurrentIntegratorScalarConcentrationTolerance(RRHandle handle, double value)
Set the scalar tolerance based on concentration for the current integrator.
C_DECL_SPEC double rrcCallConv getCurrentSteadyStateSolverParameterDouble(RRHandle handle, char *parameterName)
Get the double value for a specific steady state solver setting.
C_DECL_SPEC int rrcCallConv setCurrentIntegratorVectorConcentrationTolerance(RRHandle handle, double *value, int len)
Set the vector tolerance based on concentration for the current integrator.
C_DECL_SPEC int rrcCallConv setCurrentSteadyStateSolverParameterDouble(RRHandle handle, char *parameterName, double value)
Set the double value for a specific steady state solver setting.
C_DECL_SPEC int rrcCallConv getCurrentSteadyStateSolverNthParameterType(RRHandle handle, int n)
Get the type of a parameter of the current steady state solver.
C_DECL_SPEC char *rrcCallConv getRegisteredIntegratorDescription(int n)
Get the description of a registered integrator (e.g. cvode etc.)
C_DECL_SPEC int rrcCallConv getNumRegisteredSteadyStateSolvers()
Get the number of registered steady state solvers.
C_DECL_SPEC int rrcCallConv setCurrentIntegratorParameterUInt(RRHandle handle, char *parameterName, unsigned int value)
Set the unsigned integer value for a specific integrator setting.
C_DECL_SPEC char *rrcCallConv getCurrentSteadyStateSolverName(RRHandle handle)
Obtain a description of the current steady state solver.
C_DECL_SPEC int rrcCallConv getNumberOfCurrentIntegratorParameters(RRHandle handle)
Get the number of adjustable settings for the current integrator.
C_DECL_SPEC char *rrcCallConv getCurrentIntegratorNthParameterName(RRHandle handle, int n)
Get the name of a parameter of the current integrator.
C_DECL_SPEC int rrcCallConv getCurrentIntegratorParameterType(RRHandle handle, char *parameterName)
Get the return type for a specific integrator setting.
C_DECL_SPEC char *rrcCallConv getCurrentIntegratorNthParameterDisplayName(RRHandle handle, int n)
Get the display name of a parameter of the current integrator.
C_DECL_SPEC char *rrcCallConv getCurrentSteadyStateSolverParameterHint(RRHandle handle, char *parameterName)
Get the hint for a specific steady state solver setting.
C_DECL_SPEC int rrcCallConv setCurrentSteadyStateSolver(RRHandle handle, char *nameOfSteadyStateSolver)
Specify the current steady state solver to be used for simulation. \description This method instantia...
C_DECL_SPEC int rrcCallConv getNumInstantiatedIntegrators(RRHandle handle)
Get the number of instantiated integrators. \description To instantiate an integrator,...
C_DECL_SPEC int rrcCallConv getNumRegisteredIntegrators()
Get the number of registered integrators.
C_DECL_SPEC char *rrcCallConv getRegisteredIntegratorName(int n)
Get the name of a registered integrator (e.g. cvode etc.)
C_DECL_SPEC int rrcCallConv setCurrentSteadyStateSolverParameterBoolean(RRHandle handle, char *parameterName, int value)
Set the boolean value for a specific steady state solver setting.
C_DECL_SPEC char *rrcCallConv getCurrentIntegratorDescription(RRHandle handle)
Obtain a description of the current integrator.
C_DECL_SPEC char *rrcCallConv getCurrentIntegratorName(RRHandle handle)
Obtain a description of the current integrator.
C_DECL_SPEC char *rrcCallConv getRegisteredIntegratorHint(int n)
Get the hint of a registered integrator (e.g. cvode etc.)
C_DECL_SPEC int rrcCallConv setCurrentIntegratorParameterDoubleArray(RRHandle handle, char *parameterName, double *value, int len)
Set the double array value for a specific integrator setting. Should only used for absoluate tolerace...
C_DECL_SPEC char *rrcCallConv getCurrentIntegratorParameterDescription(RRHandle handle, char *parameterName)
Get the description for a specific integrator setting.
C_DECL_SPEC int rrcCallConv setCurrentIntegratorParameterDouble(RRHandle handle, char *parameterName, double value)
Set the double value for a specific integrator setting.
C_DECL_SPEC char *rrcCallConv getCurrentSteadyStateSolverParameterDescription(RRHandle handle, char *parameterName)
Get the description for a specific steady state solver setting.
C_DECL_SPEC char *rrcCallConv getRegisteredSteadyStateSolverName(int n)
Get the name of a registered steady state solver (e.g. cvode etc.)
C_DECL_SPEC char *rrcCallConv getCurrentIntegratorNthParameterDescription(RRHandle handle, int n)
Get the description of a parameter of the current integrator.
C_DECL_SPEC char *rrcCallConv getCurrentSteadyStateSolverNthParameterName(RRHandle handle, int n)
Get the name of a parameter of the current steady state solver.
C_DECL_SPEC char *rrcCallConv getCurrentSteadyStateSolverDescription(RRHandle handle)
Obtain a description of the current steady state solver.
C_DECL_SPEC int rrcCallConv setCurrentIntegrator(RRHandle handle, char *nameOfIntegrator)
Specify the current integrator to be used for simulation. \description This method instantiates a new...
C_DECL_SPEC int rrcCallConv setCurrentSteadyStateSolverParameterUInt(RRHandle handle, char *parameterName, unsigned int value)
Set the unsigned integer value for a specific steady state solver setting.
C_DECL_SPEC unsigned int rrcCallConv getCurrentSteadyStateSolverParameterUInt(RRHandle handle, char *parameterName)
Get the unsigned integer value for a specific steady state solver setting.
C_DECL_SPEC char *rrcCallConv getCurrentIntegratorParameterString(RRHandle handle, char *parameterName)
Get the string value for a specific integrator setting.
C_DECL_SPEC int rrcCallConv getCurrentSteadyStateSolverParameterBoolean(RRHandle handle, char *parameterName)
Get the boolean value for a specific steady state solver setting.
C_DECL_SPEC RRStringArrayPtr rrcCallConv getListOfCurrentSteadyStateSolverParameterNames(RRHandle handle)
Get the names of adjustable settings for the current steady state solver.
C_DECL_SPEC char *rrcCallConv getCurrentSteadyStateSolverNthParameterDisplayName(RRHandle handle, int n)
Get the display name of a parameter of the current steady state solver.
C_DECL_SPEC int rrcCallConv setCurrentIntegratorParameterString(RRHandle handle, char *parameterName, char *value)
Set the string value for a specific integrator setting.
C_DECL_SPEC bool rrcCallConv getTimeStart(RRHandle handle, double *timeStart)
Get the value of the current time start.
C_DECL_SPEC RRCDataPtr rrcCallConv simulateEx(RRHandle handle, const double timeStart, const double timeEnd, const int numberOfPoints)
Carry out a time-course simulation based on the given arguments, time start, time end and number of p...
C_DECL_SPEC bool rrcCallConv setNumPoints(RRHandle handle, int numberOfPoints)
Set the number of points to generate in a time course simulation.
C_DECL_SPEC bool rrcCallConv setTimeCourseSelectionList(RRHandle handle, const char *list)
Set the selection list for output from simulate(void) or simulateEx(void)
C_DECL_SPEC bool rrcCallConv setTimeStart(RRHandle handle, double timeStart)
Set the time start for a time course simulation.
C_DECL_SPEC bool rrcCallConv setConfigurationXML(RRHandle handle, const char *caps)
Set the simulator's capabilities.
C_DECL_SPEC bool rrcCallConv getTimeEnd(RRHandle handle, double *timeEnd)
Get the value of the current time end.
C_DECL_SPEC char *rrcCallConv getConfigurationXML(RRHandle handle)
Get the simulator's capabilities.
C_DECL_SPEC bool rrcCallConv oneStep(RRHandle handle, const double currentTime, const double stepSize, double *value)
Carry out a one step integration of the model.
C_DECL_SPEC bool rrcCallConv setTimeEnd(RRHandle handle, double timeEnd)
Set the time end for a time course simulation.
C_DECL_SPEC RRCDataPtr rrcCallConv simulate(RRHandle handle)
Carry out a time-course simulation. setTimeStart, setTimeEnd, setNumPoints, etc are used to set the s...
C_DECL_SPEC RRCDataPtr rrcCallConv getSimulationResult(RRHandle handle)
Retrieve the result of the last simulation.
C_DECL_SPEC bool rrcCallConv getNumPoints(RRHandle handle, int *numPoints)
Get the value of the current number of points.
C_DECL_SPEC RRStringArrayPtr rrcCallConv getTimeCourseSelectionList(RRHandle handle)
Get the current selection list for simulate(void) or simulateEx(void)
C_DECL_SPEC bool rrcCallConv evalModel(RRHandle handle)
Evaluate the current model, that it update all assignments and rates of change. Do not carry out an i...
C_DECL_SPEC RRStringArrayPtr rrcCallConv getEigenvalueIds(RRHandle handle)
Obtain the list of eigenvalue Ids.
C_DECL_SPEC RRListPtr rrcCallConv getAvailableTimeCourseSymbols(RRHandle handle)
Obtain the list of all available symbols.
C_DECL_SPEC bool rrcCallConv getValue(RRHandle handle, const char *symbolId, double *value)
Get the value for a given symbol, use getAvailableTimeCourseSymbols(void) for a list of symbols.
C_DECL_SPEC bool rrcCallConv setValue(RRHandle handle, const char *symbolId, const double value)
Set the value for a given symbol, use getAvailableTimeCourseSymbols(void) for a list of symbols.
C_DECL_SPEC RRListPtr rrcCallConv getAvailableSteadyStateSymbols(RRHandle handle)
Obtain the list of all available steady state symbols.
C_DECL_SPEC RRVectorPtr rrcCallConv computeSteadyStateValues(RRHandle handle)
A convenient method for returning a vector of the steady state species concentrations.
C_DECL_SPEC RRStringArrayPtr rrcCallConv getSteadyStateSelectionList(RRHandle handle)
Get the selection list for the steady state analysis.
C_DECL_SPEC bool rrcCallConv steadyState(RRHandle handle, double *value)
Compute the steady state of the current model.
C_DECL_SPEC bool rrcCallConv setSteadyStateSelectionList(RRHandle handle, const char *list)
Set the selection list of the steady state analysis.
C_DECL_SPEC RRCDataPtr rrcCallConv gillespieMeanSDOnGridEx(RRHandle handle, double timeStart, double timeEnd, int numberOfSteps, int numberOfSimulations)
Carry out a series of time-course simulations using the Gillespie algorithm with fixed step size,...
C_DECL_SPEC RRCDataPtr rrcCallConv gillespieOnGrid(RRHandle handle)
Carry out a time-course simulation using the Gillespie algorithm with fixed step size....
C_DECL_SPEC RRCDataPtr rrcCallConv gillespieMeanOnGrid(RRHandle handle, int numberOfSimulations)
Carry out a series of time-course simulations using the Gillespie algorithm with fixed step size,...
C_DECL_SPEC RRCDataPtr rrcCallConv gillespieMeanSDOnGrid(RRHandle handle, int numberOfSimulations)
Carry out a series of time-course simulations using the Gillespie algorithm with fixed step size,...
C_DECL_SPEC bool rrcCallConv getSeed(RRHandle handle, long *seed)
Determine the current seed used by the random generator.
C_DECL_SPEC RRCDataPtr rrcCallConv gillespieEx(RRHandle handle, double timeStart, double timeEnd)
Carry out a time-course simulation using the Gillespie algorithm based on the given arguments,...
C_DECL_SPEC RRCDataPtr rrcCallConv gillespieMeanOnGridEx(RRHandle handle, double timeStart, double timeEnd, int numberOfPoints, int numberOfSimulations)
Carry out a series of time-course simulations using the Gillespie algorithm with fixed step size,...
C_DECL_SPEC bool rrcCallConv setSeed(RRHandle handle, long seed)
Set the current seed used by the random generator.
C_DECL_SPEC RRCDataPtr rrcCallConv gillespieOnGridEx(RRHandle handle, double timeStart, double timeEnd, int numberOfPoints)
Carry out a time-course simulation using the Gillespie algorithm with fixed step size based on the gi...
C_DECL_SPEC RRCDataPtr rrcCallConv gillespie(RRHandle handle)
Carry out a time-course simulation using the Gillespie algorithm with variable step size....
C_DECL_SPEC char *rrcCallConv getCPPAPIVersion(RRHandle handle)
Retrieve the current version number of the C++ wrappers (Core RoadRunner wrappers) library.
C_DECL_SPEC bool rrcCallConv setSupportCodeFolder(RRHandle handle, const char *folder)
Set the path to a folder containing support code for model generation.
C_DECL_SPEC char *rrcCallConv getRRCAPILocation(void)
Retrieve the directory path of the shared rrCApi library.
C_DECL_SPEC char *rrcCallConv getlibSBMLVersion(RRHandle handle)
Retrieve the current version number of the libSBML library.
C_DECL_SPEC char *rrcCallConv getCompilerLocation(RRHandle handle)
Get the path to a folder containing the compiler being used.
C_DECL_SPEC char *rrcCallConv getBuildTime(void)
Retrieve the current build time (HH:MM:SS) of the library.
C_DECL_SPEC char *rrcCallConv getTempFolder(RRHandle handle)
Retrieve the current temporary folder path.
C_DECL_SPEC char *rrcCallConv getBuildDateTime(void)
Retrieve the current build date + time of the library.
C_DECL_SPEC bool rrcCallConv setTempFolder(RRHandle handle, const char *folder)
Set the path to the temporary folder where the C code will be stored.
C_DECL_SPEC bool rrcCallConv setCompiler(RRHandle handle, const char *fNameWithPath)
Set the path and filename to the compiler to be used by roadrunner.
C_DECL_SPEC char *rrcCallConv getExtendedAPIInfo()
Retrieve extended wrappers info.
C_DECL_SPEC char *rrcCallConv getCopyright(void)
Retrieve the current copyright notice for the library.
C_DECL_SPEC char *rrcCallConv getInfo(RRHandle handle)
Retrieve info about current state of roadrunner, e.g. loaded model, conservationAnalysis etc.
C_DECL_SPEC bool rrcCallConv setCodeGenerationMode(RRHandle handle, int mode)
Set the runtime generation option [Not yet implemented].
C_DECL_SPEC bool rrcCallConv setCompilerLocation(RRHandle handle, const char *folder)
Set the path to a folder containing the compiler to be used.
C_DECL_SPEC char *rrcCallConv getBuildDate(void)
Retrieve the current build date of the library.
C_DECL_SPEC char *rrcCallConv getSupportCodeFolder(RRHandle handle)
Get the path to a folder containing support code.
C_DECL_SPEC char *rrcCallConv getWorkingDirectory(void)
Retrieve the current working directory path.
C_DECL_SPEC char *rrcCallConv getCompiler(RRHandle handle)
Get the name of the compiler currently being used by roadrunner.
C_DECL_SPEC char *rrcCallConv getAPIVersion(void)
Retrieve the current version number of the C wrappers library.
C_DECL_SPEC double rrcCallConv _getTime(RRHandle handle)
C_DECL_SPEC char *rrcCallConv getParamPromotedSBML(RRHandle handle, const char *sArg)
Promote any local parameters to global status.
C_DECL_SPEC int rrcCallConv getVersion()
C_DECL_SPEC char *rrcCallConv getVersionStr()
C_DECL_SPEC void rrcCallConv _getStateVectorRate(RRHandle handle, double time, double *value)
C_DECL_SPEC int rrcCallConv _getStateVector(RRHandle handle)
C_DECL_SPEC int rrcCallConv _getNumIndFloatingSpecies(RRHandle handle)
C_DECL_SPEC char *rrcCallConv getVersionEx()
C_DECL_SPEC int rrcCallConv _getNumRateRules(RRHandle handle)
roadRunner C wrappers 2012
roadRunner C wrappers 2012
roadRunner C wrappers 2012
roadRunner C wrappers 2012
roadRunner C wrappers 2012
void * RRHandle
Void pointer to a RoadRunner instance.
Definition: rrc_types.h:50
roadRunner C wrappers 2012
Structure for the result type from the simulate calls. The client is responsible for freeing the RRCD...
Definition: rrc_types.h:111
Structure for a simple double Matrix type.
Definition: rrc_types.h:74
A list type, stores int, double, strings and lists.
Definition: rrc_types.h:148
Structure for a simple vector of strings.
Definition: rrc_types.h:66
Structure for a simple vector of doubles.
Definition: rrc_types.h:58