cellml_api::GroupSet Interface Reference

cellml_api::GroupSet Interface Reference

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

Inheritance diagram for cellml_api::GroupSet:
Collaboration diagram for cellml_api::GroupSet:

Public Member Functions

GroupIterator iterateGroups ()
 Returns a GroupIterator that can be used to iterate through the group elements.
GroupSet getSubsetInvolvingRelationship (in CellMLAttributeString relName)
 Returns the subset of this set containing groups involving a particular relationship.
- 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.

Public Attributes

readonly attribute GroupSet subsetInvolvingEncapsulation
 The subset of all groups in this collection involving encapsulation.
readonly attribute GroupSet subsetInvolvingContainment
 The subset of all groups in this collection involving containment.
- Public Attributes inherited from cellml_api::CellMLElementSet
readonly attribute unsigned long length
 The length of the collection.
- Public Attributes inherited from XPCOM::IObject
readonly attribute string objid
 Fetches the ID of the object.

Detailed Description

An interface for accessing a set of Group elements.

Definition at line 1752 of file CellML_APISPEC.idl.

Member Function Documentation

GroupSet cellml_api::GroupSet::getSubsetInvolvingRelationship ( in CellMLAttributeString  relName)

Returns the subset of this set containing groups involving a particular relationship.

Parameters
relNameThe relationship groups must contain to be in the returned set.
Returns
GroupSet The new set of groups.
GroupIterator cellml_api::GroupSet::iterateGroups ( )

Returns a GroupIterator that can be used to iterate through the group elements.

The iteration order is undefined.

Member Data Documentation

readonly attribute GroupSet cellml_api::GroupSet::subsetInvolvingContainment

The subset of all groups in this collection involving containment.

Definition at line 1779 of file CellML_APISPEC.idl.

readonly attribute GroupSet cellml_api::GroupSet::subsetInvolvingEncapsulation

The subset of all groups in this collection involving encapsulation.

Definition at line 1773 of file CellML_APISPEC.idl.