cellml_services::CellMLIntegrationRun Interface Reference

Inheritance diagram for cellml_services::CellMLIntegrationRun:

Collaboration diagram for cellml_services::CellMLIntegrationRun:

Public Member Functions
void	setStepSizeControl (in double epsAbs, in double epsRel, in double scalVar, in double scalRate, in double maxStep)
	Sets a standard step size control function.
void	setTabulationStepControl (in double tabulationStepSize, in boolean strictTabulation)
	Sets a tabulation interval.
void	setResultRange (in double startBvar, in double stopBvar, in double maxPointDensity)
	Sets the range of results to be returned.
void	setProgressObserver (in IntegrationProgressObserver ipo)
	Sets the progress observer...
void	setOverride (in cellml_services::VariableEvaluationType type, in unsigned long variableIndex, in double newValue) raises (cellml_api::CellMLException)
	Sets an initial condition override.
void	start ()
	Starts the integration running.
void	stop ()
	Requests that the integration stop immediately.
void	pause ()
	Requests that the integration be paused; no further results will be delivered until resume() is called.
void	resume ()
	Requests that the integration, which has previously been stopped with pause, be resumed.
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.
readonly attribute interface_list	supported_interfaces
	Fetches all supported interfaces.

Detailed Description

Definition at line 81 of file CIS.idl.

Member Function Documentation

void cellml_services::CellMLIntegrationRun::pause

(

)

Requests that the integration be paused; no further results will be delivered until resume() is called.

It is the responsibility of the caller to ensure that resume() is called for every call to pause(), even if operation other than resume() on the CellMLIntegrationRun after pause has been called.

void cellml_services::CellMLIntegrationRun::resume

(

)

Requests that the integration, which has previously been stopped with pause, be resumed.

void cellml_services::CellMLIntegrationRun::setOverride	(	in cellml_services::VariableEvaluationType	type,
		in unsigned long	variableIndex,
		in double	newValue
	)		raises (cellml_api::CellMLException)

Sets an initial condition override.

This is used to change parameters which have been modified since the model was compiled, without forcing a recompilation.

Parameters

type	The type of variable to set. Can be CONSTANT (sets the value of the constant) or STATE_VARIABLE (sets the initial value of the the state variable).
variableIndex	The index into the relevant array, as provided by the CCGS VariableInformation structures. When working with second or higher differentials, you can use this to specify which derivative.
newValue	The value to assign.

void cellml_services::CellMLIntegrationRun::setProgressObserver

(

in IntegrationProgressObserver

ipo

)

Sets the progress observer...

Parameters

ipo	The progress observer to set. If this is null, the progress observer is cleared. Note that there can only be a single progress observer at any one time.

void cellml_services::CellMLIntegrationRun::setResultRange	(	in double	startBvar,
		in double	stopBvar,
		in double	maxPointDensity
	)

Sets the range of results to be returned.

Parameters

startBvar	The first value of the bound variable.
stopBvar	The final value of the bound variable.
maxPointDensity	The maximum point density allowed across any bound variable range containing two or more points. The density is expressed in terms of points between stopBvar and startBvar. Note that startBvar <= stopBvar is required to get integration results. However, it is not an error otherwise, and so this can be used to get results when there are no ODEs involved (for example, to find the value of computed constants).

void cellml_services::CellMLIntegrationRun::setStepSizeControl	(	in double	epsAbs,
		in double	epsRel,
		in double	scalVar,
		in double	scalRate,
		in double	maxStep
	)

Sets a standard step size control function.

Parameters

epsAbs	The absolute error control.
epsRel	The relative error control.
scalVar	The weighting of the variables in the error control equation.
scalRate	The weighting of the rates in the error control equation.
maxStep	The maximum step size to ever take.

void cellml_services::CellMLIntegrationRun::setTabulationStepControl	(	in double	tabulationStepSize,
		in boolean	strictTabulation
	)

Sets a tabulation interval.

Parameters

tabulationStepSize	The tabulation step size. If set to zero, it will be internally set to the final value of the bound variable.
strictTabulation	If true, only tabulate at tabulation points. Otherwise, at least ensure that there are data points at the tabulation points.

void cellml_services::CellMLIntegrationRun::start

(

)

Starts the integration running.

Results will get notified to the progress observer.

void cellml_services::CellMLIntegrationRun::stop

(

)

Requests that the integration stop immediately.