cellml_api::CellMLComponentIterator Interface Reference

cellml_api::CellMLComponentIterator Interface Reference

An interface allowing CellMLComponents to be iterated. More...

Inheritance diagram for cellml_api::CellMLComponentIterator:
Collaboration diagram for cellml_api::CellMLComponentIterator:

Public Member Functions

CellMLComponent nextComponent ()
 Fetches the next CellMLComponent, and advances the iterator.
- Public Member Functions inherited from cellml_api::CellMLElementIterator
CellMLElement next ()
 Fetches the next CellML element, and advances the iterator.
- 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

An interface allowing CellMLComponents to be iterated.

Definition at line 1482 of file CellML_APISPEC.idl.

Member Function Documentation

CellMLComponent cellml_api::CellMLComponentIterator::nextComponent ( )

Fetches the next CellMLComponent, and advances the iterator.

Returns
The next CellMLComponent, or nil if there are no more CellMLComponents.