SRuS::GeneratedDataMonitor Interface Reference

GeneratedDataMonitor is a 'callback' interface implemented by the application to receive updates as more generated data becomes available. More...

Inheritance diagram for SRuS::GeneratedDataMonitor:

Collaboration diagram for SRuS::GeneratedDataMonitor:

Public Member Functions
void	progress (in GeneratedDataSet aData)
	Called when new data points are available in the GeneratedData.
void	failure (in string aErrMsg)
	Called in the event of a failure generating the results.
void	done ()
	Called after the computation has successfully completed.
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

GeneratedDataMonitor is a 'callback' interface implemented by the application to receive updates as more generated data becomes available.

Definition at line 119 of file SRuS.idl.

Member Function Documentation

void SRuS::GeneratedDataMonitor::done

(

)

Called after the computation has successfully completed.

void SRuS::GeneratedDataMonitor::failure

(

in string

aErrMsg

)

Called in the event of a failure generating the results.

Parameters

aErrMsg

describes the error that occurred.

void SRuS::GeneratedDataMonitor::progress

(

in GeneratedDataSet

aData

)

Called when new data points are available in the GeneratedData.

Only new data points will be present in the generated data. An application wanting to keep all results needs to copy data from the GeneratedDataSet / GeneratedData structure before returning from progress(); after returning from progress(), it is not safe to make further references to the GeneratedDataSet even if a reference has been held.