CellML Discussion List

Text archives Help


[cellml-discussion] Errata: CellML API specification


Chronological Thread 
  • From: ak.miller at auckland.ac.nz (Andrew Miller)
  • Subject: [cellml-discussion] Errata: CellML API specification
  • Date: Thu, 16 Feb 2006 11:08:05 +1300

I have made a few small corrections to the IDL for the CellML API. A unified
diff for these corrections is attached below.

======================= Begin Changes
=========================================
--- CellML-APISPEC.idl 2005-10-25 14:12:44.000000000 +1300
+++ /people/amil082/code/CellML_DOM_API/interfaces/CellML-APISPEC.idl
2006-02-16
10:43:26.608871059 +1300
@@ -786,7 +786,7 @@
/**
* The name of the component containing this CellMLVariable.
*/
-
+ readonly attribute CellMLAttributeString componentName;
};

/**
@@ -851,12 +851,12 @@
/**
* The collection of relationship references.
*/
- attribute RelationshipRefSet relationshipRefs;
+ readonly attribute RelationshipRefSet relationshipRefs;

/**
* The collection of component references.
*/
- attribute ComponentRefSet componentRefs;
+ readonly attribute ComponentRefSet componentRefs;

/**
* @todo Find out what Matt meant by the following
@@ -1457,7 +1457,7 @@
* Returns a CellMLElementIterator that can be used to iterate through
the
* elements. The iteration order is undefined.
*/
- UnitIterator iterateImports();
+ UnitIterator iterateUnits();
};

interface ConnectionIterator : CellMLElementIterator
========================= End Changes
=========================================

The componentName attribute was intended to be added to the IDL, as the
comments
indicate, but was missed out.

The relationshipRefs and componentRefs attributes are sets, and as the user
has
no way to create sets, should have been made readonly(like all the other set
attributes in the IDL).

The getter function for the unit iterator was inadvertantly named
iterateImports
in the original specification, but should have been called iterateUnits.

I will be proposing at the CellML meeting today that these changes be adopted
as
normative(as well as some other issues with the API which are less obvious and
need further discussion).

Best regards,
Andrew Miller


----------------------------------------------------------------
This message was sent using IMP, the Internet Messaging Program.



  • [cellml-discussion] Errata: CellML API specification, Andrew Miller, 02/16/2006

Archive powered by MHonArc 2.6.18.

Top of page