cellml_api::UnitsSet Interface Reference

cellml_api::UnitsSet Interface Reference

An interface for accessing a set of Units. More...

Inheritance diagram for cellml_api::UnitsSet:
Collaboration diagram for cellml_api::UnitsSet:

Public Member Functions

UnitsIterator iterateUnits ()
 Returns a UnitsIterator that can be used to iterate through the Units elements.
Units getUnits (in CellMLAttributeString name)
 Fetch a Units element 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 Units.

Definition at line 1599 of file CellML_APISPEC.idl.

Member Function Documentation

Units cellml_api::UnitsSet::getUnits ( in CellMLAttributeString  name)

Fetch a Units element by name.

Parameters
nameThe name of the units.
Returns
The Units element, or nil if not found.
UnitsIterator cellml_api::UnitsSet::iterateUnits ( )

Returns a UnitsIterator that can be used to iterate through the Units elements.

The iteration order is undefined.