cellml_api::CellMLVariableSet Interface Reference

cellml_api::CellMLVariableSet Interface Reference

An interface for accessing a set of CellMLVariable elements. More...

Inheritance diagram for cellml_api::CellMLVariableSet:
Collaboration diagram for cellml_api::CellMLVariableSet:

Public Member Functions

CellMLVariableIterator iterateVariables ()
 Returns a CellMLVariableIterator that can be used to iterate through the CellMLVariable elements.
CellMLVariable getVariable (in CellMLAttributeString name)
 Fetch a variable by name.
- Public Member Functions inherited from cellml_api::NamedCellMLElementSet
NamedCellMLElement get (in CellMLAttributeString name)
 Fetch a NamedCellMLElement by name.
- Public Member Functions inherited from cellml_api::CellMLElementSet
boolean contains (in CellMLElement x)
 Tests for the existance of an element in the set.
CellMLElementIterator iterate ()
 Returns a CellMLElementIterator that can be used to iterate through the elements.
- 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 cellml_api::CellMLElementSet
readonly attribute unsigned long length
 The length of the collection.

Detailed Description

An interface for accessing a set of CellMLVariable elements.

Definition at line 1565 of file CellML_APISPEC.idl.

Member Function Documentation

CellMLVariable cellml_api::CellMLVariableSet::getVariable ( in CellMLAttributeString  name)

Fetch a variable by name.

Parameters
nameThe name of the variable.
Returns
The CellMLVariable, or nil if not found.
CellMLVariableIterator cellml_api::CellMLVariableSet::iterateVariables ( )

Returns a CellMLVariableIterator that can be used to iterate through the CellMLVariable elements.

The iteration order is undefined.