cellml_services::IntegrationProgressObserver Interface Reference

Inheritance diagram for cellml_services::IntegrationProgressObserver:

Collaboration diagram for cellml_services::IntegrationProgressObserver:

Public Member Functions
void	computedConstants (in DoubleSeq values)
	Called once the computed constants have been evaluated.
void	results (in DoubleSeq state)
	Called when integration results become available.
void	done ()
	Called after integration has sucessfully completed.
void	failed (in string errorMessage)
	Called if integration has failed.
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.

Additional Inherited Members
Public Attributes inherited from XPCOM::IObject
readonly attribute string	objid
	Fetches the ID of the object.

Detailed Description

Definition at line 30 of file CIS.idl.

Member Function Documentation

void cellml_services::IntegrationProgressObserver::computedConstants

(

in DoubleSeq

values

)

Called once the computed constants have been evaluated.

Parameters

values

A sequence of computed constant values. The indices into the sequence match those provided by the CCGS.

void cellml_services::IntegrationProgressObserver::done

(

)

Called after integration has sucessfully completed.

void cellml_services::IntegrationProgressObserver::failed

(

in string

errorMessage

)

Called if integration has failed.

Parameters

msg	An error message describing why it failed.

void cellml_services::IntegrationProgressObserver::results

(

in DoubleSeq

state

)

Called when integration results become available.

The first results reproduce the initial conditions, with the second result being for the initial plus the bvar increment, and so on.

Parameters

state

A sequence of result entries, for one or more bvar values. Each entry has the following structure: +------—+---------—+-------------------------------—+ | Index | Length | Description | +------—+---------—+-------------------------------—+ | 0 | 1 | Variable of integration (e.g. | | | | time) | +------—+---------—+-------------------------------—+ | 1 | nS | The states array, using indices | | | | from the CCGS. | +------—+---------—+-------------------------------—+ | nS+1 | nS | The rates array. | +------—+---------—+-------------------------------—+ | 2*nS+1 | nA | The algebraic variables array. | +------—+---------—+-------------------------------—+ nS is the number of state variables, nA is the number of algebraic variables.

Any individual call of results() will carry one or more of the above records, and so will contain an exact multiple of 2*nS + 1 + nA doubles in the sequence.