cellml_services::CodeInformation Interface Reference

cellml_services::CodeInformation Interface Reference
Inheritance diagram for cellml_services::CodeInformation:
Collaboration diagram for cellml_services::CodeInformation:

Public Member Functions

ComputationTargetIterator iterateTargets ()
 Iterates through all computation targets.
- Public Member Functions inherited from XPCOM::IObject
void add_ref ()
 Called to indicate that some code is keeping an owning reference to the object.
oneway void release_ref ()
 Removes a reference to an object which was created by some other means (e.g.
IObject query_interface (in utf8string id)
 Returns an IObject of the same implementation, which supports a specific interface.

Public Attributes

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.
readonly attribute
ComputationTarget 
missingInitial
 If the solver failed with an underconstrained error, and this is non-null, it means the cause of the failure was a missing initial condition on this state variable.
- Public Attributes inherited from XPCOM::IObject
readonly attribute string objid
 Fetches the ID of the object.
readonly attribute interface_list supported_interfaces
 Fetches all supported interfaces.

Detailed Description

Definition at line 157 of file CCGS.idl.

Member Function Documentation

ComputationTargetIterator cellml_services::CodeInformation::iterateTargets ( )

Iterates through all computation targets.

Member Data Documentation

readonly attribute unsigned long cellml_services::CodeInformation::algebraicIndexCount

The number of variables which were assigned indices in the algebraic variables array.

This counts a single CellML variable multiple times if extra variables are inserted due to higher order derivatives.

Definition at line 179 of file CCGS.idl.

readonly attribute unsigned long cellml_services::CodeInformation::constantIndexCount

The number of variables which were assigned indices into the constants array.

Definition at line 192 of file CCGS.idl.

readonly attribute ModelConstraintLevel cellml_services::CodeInformation::constraintLevel

The constraint level, describing whether or not the model is correctly constrained.

Note that improperly constrained models result in constraintLevel being set, rather than setting an errorMessage.

Definition at line 172 of file CCGS.idl.

readonly attribute wstring cellml_services::CodeInformation::errorMessage

The error message, in the event that something is wrong with the model.

If this is set, code should not use further operations or attributes on this object.

Definition at line 165 of file CCGS.idl.

readonly attribute mathml_dom::MathMLNodeList cellml_services::CodeInformation::flaggedEquations

The list of flagged equations.

Which equations are flagged depends on the outcome in constraintLevel. See the documentation on ModelConstraintLevel for more information.

Definition at line 264 of file CCGS.idl.

readonly attribute wstring cellml_services::CodeInformation::functionsString

A string containing any supplementary code which is needed to be used out-of-line by the above strings.

Whether or not supplementary code is used, and exactly what it means depends on the MAL file used with MaLaES, and the options set on the CodeGenerator. Typically, for C, it is used to define extra functions that are passed as arguments to functions being called from expressions.

Definition at line 252 of file CCGS.idl.

readonly attribute wstring cellml_services::CodeInformation::initConstsString

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'. 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.

StringTargeted VariablesPossibly computed variablesKnown variablesPurpose
initConsts All variables which aren't state variables but have an initial_value attribute, and any variables & rates which follow Any variable or rate except VOIs & state variables NoneSetting up constants and values computed from them. Also sets up samples of uncertain values
ratesAll rates which are not staticAny variable or rateEverything set above, VOIs, & state variables Efficiently computing rates for the ODE solver
variablesAll variables not computed aboveAny variableEverything set above, VOIs, and state variables Computing the remaining variables

Note that some rates also have corresponding higher order entries in the state variables array. These rates are copied from the state variables array into the rates array at the beginning of the rates string, and may be relied upon in the rates string. e.g.

Array / Index 0 1 2
STATES x dx/dt d^2x/dt^2
RATES dx/dtd^2x/dt^2d^3x/dt^3

RATES[1] is copied from STATES[2], and RATES[0] is copied from STATES[1]. The initConsts string, as described in the table above.

Definition at line 232 of file CCGS.idl.

readonly attribute ComputationTarget cellml_services::CodeInformation::missingInitial

If the solver failed with an underconstrained error, and this is non-null, it means the cause of the failure was a missing initial condition on this state variable.

Definition at line 271 of file CCGS.idl.

readonly attribute unsigned long cellml_services::CodeInformation::rateIndexCount

The number of variables which were assigned indices into the rates and state variables array.

This counts a single CellML variable multiple times if extra rates are inserted due to higher order derivatives.

Definition at line 186 of file CCGS.idl.

readonly attribute wstring cellml_services::CodeInformation::ratesString

The rates string, as described in the table above.

Definition at line 237 of file CCGS.idl.

readonly attribute wstring cellml_services::CodeInformation::variablesString

The variables string, as described in the table above.

Definition at line 242 of file CCGS.idl.