CellML API
cellml_services::IDACodeInformation Interface Reference
Public Attributes | |
| readonly attribute wstring | essentialVariablesString |
| There are three types of code strings that can be obtained, each for a different purpose. | |
| readonly attribute wstring | stateInformationString |
| The string for setting up the state information descriptor. | |
| readonly attribute unsigned long | conditionVariableCount |
| The number of condition variables allocated by the trackPiecewiseConditions feature. | |
| readonly attribute wstring | rootInformationString |
| A string for computing the roots controlling each condition variable. | |
 Public Attributes inherited from cellml_services::CodeInformation | |
| readonly attribute wstring | errorMessage |
| The error message, in the event that something is wrong with the model. | |
| readonly attribute ModelConstraintLevel | constraintLevel |
| The constraint level, describing whether or not the model is correctly constrained. | |
| readonly attribute unsigned long | algebraicIndexCount |
| The number of variables which were assigned indices in the algebraic variables array. | |
| readonly attribute unsigned long | rateIndexCount |
| The number of variables which were assigned indices into the rates and state variables array. | |
| readonly attribute unsigned long | constantIndexCount |
| The number of variables which were assigned indices into the constants array. | |
| readonly attribute wstring | initConstsString |
| There are three types of code strings that can be obtained, each for a different purpose. | |
| readonly attribute wstring | ratesString |
| The rates string, as described in the table above. | |
| readonly attribute wstring | variablesString |
| The variables string, as described in the table above. | |
| readonly attribute wstring | functionsString |
| A string containing any supplementary code which is needed to be used out-of-line by the above strings. | |
| readonly attribute mathml_dom::MathMLNodeList | flaggedEquations |
| The list of flagged equations. | |
| Public Attributes inherited from XPCOM::IObject | |
| readonly attribute string | objid |
| Fetches the ID of the object. | |
Additional Inherited Members | |
| Public Member Functions inherited from cellml_services::CodeInformation | |
| ComputationTargetIterator | iterateTargets () |
| Iterates through all computation targets. | |
Detailed Description
Member Data Documentation
| readonly attribute unsigned long cellml_services::IDACodeInformation::conditionVariableCount |
| readonly attribute wstring cellml_services::IDACodeInformation::essentialVariablesString |
There are three types of code strings that can be obtained, each for a different purpose.
Note that as variables are computed, they are added into 'Known variables'. This table differs slightly from CodeInformation even for the common inherited strings.
Definitions: State variable: A variable of which the first or higher derivative is taken. VOI or Variable of Integration: A variable with respect to which the model is being integrated. +----——+--------------——+-----------——+--------——+------------——+ | String | Targeted Variables |Possibly computed| Known | Purpose | | | | variables | Variables | | +----——+--------------——+-----------——+--------——+------------——+ |initConsts|All variables which | Any variable | None |Setting up | | |aren't state | or rate | |constants and | | |variables but have | except VOIs & | |values computed | | |an initial_value | state variables| |from them. | | |attribute, and any | & pseudostate | | | | |variables & rates | variables. | | | | |which follow. | | | | +----——+--------------——+-----------——+--------——+------------——+ |essential |All variables which |Any variable |Everything set|Computing variable| |Variables |are not rates, have | |above, VOIs, |s other than state| | |analytic solution, &| |and state |variables. | | |needed for rates. | |variables | | +----——+--------------——+-----------——+--------——+------------——+ | rates |The residuals of all|Any variable or |Everything set|Efficiently | | |rates and states and|rate |above, VOIs, |computing rates | | |pseudostate variable| |& state |for the ODE solver| | |s. | |variables | | +----——+--------------——+-----------——+--------——+------------——+ |variables |All variables not |Any variable |Everything set|Computing the | | |are not rates, have | |above, VOIs, |remaining | | |analytic solution, &| |and state |variables. | | |needed for rates. | |variables | | +----——+--------------——+-----------——+--------——+------------——+ The essential variables string, as described in the table above.
| readonly attribute wstring cellml_services::IDACodeInformation::rootInformationString |
