CellML API
SRuS::GeneratedData Interface Reference
SRuS::GeneratedData Interface Reference
GeneratedData describes the output of a single DataGenerator. More...
Inheritance diagram for SRuS::GeneratedData:
Collaboration diagram for SRuS::GeneratedData:
Public Member Functions | |
| double | dataPoint (in unsigned long idx) raises (SRuSException) |
| Retrieves a specific generated data point. | |
 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 SProS::DataGenerator | sedmlDataGenerator |
| The SED-ML DataGenerator corresponding to this GeneratedData. | |
| readonly attribute unsigned long | length |
| Retrieves the number of data points (for uniform time-course simulations, there will usually be one value for each output time-step). | |
| Public Attributes inherited from XPCOM::IObject | |
| readonly attribute string | objid |
| Fetches the ID of the object. | |
Detailed Description
GeneratedData describes the output of a single DataGenerator.
Note that when this interface is obtained from calls to GeneratedDataMonitor, the data is not necessarily provided all at once, but instead, may be provided a few points at a time as results come in.
Member Function Documentation
| double SRuS::GeneratedData::dataPoint | ( | in unsigned long | idx | ) | raises (SRuSException) |
Retrieves a specific generated data point.
Valid indices are from 0 through to length-1.
Member Data Documentation
| readonly attribute unsigned long SRuS::GeneratedData::length |
| readonly attribute SProS::DataGenerator SRuS::GeneratedData::sedmlDataGenerator |
The SED-ML DataGenerator corresponding to this GeneratedData.