UpdatedCellMLAPIIDL

Taken from the <a href="http://www.cellml.org/pipermail/cellml-discussion/2005-March/000046.html">cellml-discussion mailing list message</a> on March 26, 2005. This CellML API is based upon the specification at<a href="apifiles/APIideas.pdf"> apifiles/APIideas.pdf</a> by Matt Halstead. It has the following differences: 1) It is a formulated in IDL instead as in a "more casual approach". 2) The naming of some objects has been changed to better fit into the usual way of doing things in IDL. For example, mixed case is used to separate words in identifiers, instead of underscores. In addition, CellML was appended to a number of names, like Component, to avoid conflicts with IDL reserved words. Some names were also changed because case-insensitive conflicts of attribute and interface names is not allowed in IDL. 3) As required by IDL, a decision about what attributes were readonly and which ones are read-write was made. Furthermore, all methods which take no parameters, return no values, and are not expected to have any side effects were converted to readonly attributes. Attributes referring to a CollectionOf* were all made to be read-only(this doesn't mean you can't do any operations on the collection that modify the collection, it just means you can't switch the connection itself). 4) The collection architecture was changed somewhat to accomodate the need for immutable collections. There are now ConstCollectionOf* and CollectionOf* collections available, related by an inheritance hierarchy. The polymorphic inheritance hierarchy chosen may need further study to ensure it is generally applicable. This version has Doxygen/Javadoc style comments on every interface(except forward definitions), attribute, method, enumeration, and enumeration option. Things which require further work are flagged with @todo. There are a number of these: CellMLAttributeString has two @todo flags, one for whose responsibility escaping is, and another for the underlying IDL datatype to use. The model interface has two @todo flags, one because I removed the model manager as previously agreed in-person with Matt(but not yet reflected in Matt's spec), and this needs further work, and one because the namespace map was removed, again based on what Matt and I agreed on in-person. CellMLImport::fullyInstantiate has a @todo flag to properly define "full instantiation". ImportComponent::componentRef has a @todo flag to define what happens if componentRef is changed after fullyInstantiate() is called. Group has a @todo flag because I don't understand what

Component get_parent_component_name(component name) Component get_children_component_names(component name)

means. Best regards, Andrew

The API specification in IDL: <a href="apifiles/CellML-1.1-API-2005-03-26.idl/file_view">apifiles/CellML-1.1-API-2005-03-26.idl</a>.