CellML API
cellml_api Namespace Reference
This module contains a description of the CellML Application Programming Interface in the language-neutral IDL form. More...
Classes | |
| interface | RDFRepresentation |
| This interface is the generic base class for all RDF representations. More... | |
| interface | RDFXMLDOMRepresentation |
| The RDF representation for type="http://www.cellml.org/RDFXML/DOM". More... | |
| interface | RDFXMLStringRepresentation |
| The RDF representation for type="http://www.cellml.org/RDFXML/string". More... | |
| interface | UserData |
| This interface can be inherited from by the user for use in annotations. More... | |
| interface | ImportInstantiationListener |
| This interface is implemented by the application to receive notification when an asynchronous import instantiatiation is complete. More... | |
| exception | CellMLException |
| Indicates that something went wrong. More... | |
| interface | URI |
| Represents a uniform resource indicator, conforming to RFC2396 (http://rfc.net/rfc2396.html). More... | |
| interface | CellMLElement |
| This is a general interface from which all CellML elements inherit. More... | |
| interface | CellMLDOMElement |
| This is an optional additional interface which CellMLElements may implement. More... | |
| interface | NamedCellMLElement |
| This is a general interface from which all CellML elements which have a name attribute inherit. More... | |
| interface | Model |
| This interface represents a <model> element in the XML. More... | |
| interface | MathContainer |
| interface | CellMLComponent |
| This interface represents a component element in the CellML document. More... | |
| interface | Units |
| interface | Unit |
| Interface to a <unit> element. More... | |
| interface | CellMLImport |
| This interface represents a CellML import element. More... | |
| interface | ImportComponent |
| This interface represents a component element inside an import element. More... | |
| interface | ImportUnits |
| This interface represents a <units> found in <import> More... | |
| interface | CellMLVariable |
| Represents a <variable> element in a CellML document. More... | |
| interface | ComponentRef |
| Represents a <component_ref> element in a group element or in another <component_ref> element. More... | |
| interface | RelationshipRef |
| Represents a relationship_ref element in a group element. More... | |
| interface | Group |
| Represents a <group> element. More... | |
| interface | Connection |
| Represents a <connection> element. More... | |
| interface | MapComponents |
| An interface the map_components element. More... | |
| interface | MapVariables |
| An interface the map_variables element. More... | |
| interface | Reaction |
| An interface to a <reaction> element. More... | |
| interface | VariableRef |
| An interface to the <variable_ref> element. More... | |
| interface | Role |
| An interface to the <role> element. More... | |
| interface | CellMLElementIterator |
| An interface allowing CellMLElements to be iterated. More... | |
| interface | MathMLElementIterator |
| An interface allowing MathMLElements to be iterated. More... | |
| interface | ExtensionElementList |
| A collection of extension elements. More... | |
| interface | MathList |
| A collection of math. More... | |
| interface | ExtensionAttributeIterator |
| An interface for iterating through all extension attributes. More... | |
| interface | ExtensionAttributeSet |
| A set of extension attributes. More... | |
| interface | CellMLElementSet |
| An immutable collection of CellML elements. More... | |
| interface | NamedCellMLElementSet |
| An interface for accessing a collection of NamedCellMLElements. More... | |
| interface | ModelIterator |
| An interface allowing Model elements to be iterated. More... | |
| interface | ModelSet |
| An interface for accessing a collection of models. More... | |
| interface | CellMLComponentIterator |
| An interface allowing CellMLComponents to be iterated. More... | |
| interface | CellMLComponentSet |
| An interface for accessing a set of CellMLComponents. More... | |
| interface | ImportComponentIterator |
| An interface allowing ImportComponents to be iterated. More... | |
| interface | ImportComponentSet |
| An interface for accessing a set of ImportComponents. More... | |
| interface | CellMLVariableIterator |
| An interface allowing CellMLVariables to be iterated. More... | |
| interface | CellMLVariableSet |
| An interface for accessing a set of CellMLVariable elements. More... | |
| interface | UnitsIterator |
| An interface allowing Units to be iterated. More... | |
| interface | UnitsSet |
| An interface for accessing a set of Units. More... | |
| interface | ImportUnitsIterator |
| An interface allowing ImportUnits to be iterated. More... | |
| interface | ImportUnitsSet |
| An interface for accessing a set of ImportUnits. More... | |
| interface | CellMLImportIterator |
| An interface allowing Imports to be iterated. More... | |
| interface | CellMLImportSet |
| An interface for accessing a set of Imports. More... | |
| interface | UnitIterator |
| An interface allowing Unit elements to be iterated. More... | |
| interface | UnitSet |
| An interface for accessing a set of Unit elements. More... | |
| interface | ConnectionIterator |
| An interface allowing connection elements to be iterated. More... | |
| interface | ConnectionSet |
| An interface for accessing a set of connection elements. More... | |
| interface | GroupIterator |
| An interface allow Group elements to be iterated. More... | |
| interface | GroupSet |
| An interface for accessing a set of Group elements. More... | |
| interface | RelationshipRefIterator |
| An interface allowing RelationshipRef elements to be iterated. More... | |
| interface | RelationshipRefSet |
| An interface for accessing a set of RelationshipRef elements. More... | |
| interface | ComponentRefIterator |
| An interface allowing ComponentRef elements to be iterated. More... | |
| interface | ComponentRefSet |
| An interface for accessing a set of ComponentRef elements. More... | |
| interface | MapVariablesIterator |
| An interface allowing MapVariables elements to be iterated. More... | |
| interface | MapVariablesSet |
| An interface for accessing a set of MapVariables elements. More... | |
| interface | ReactionIterator |
| An interface allowing Reaction elements to be iterated. More... | |
| interface | ReactionSet |
| An interface for accessing a set of Reaction elements. More... | |
| interface | VariableRefIterator |
| An interface allowing VariableRef elements to be iterated. More... | |
| interface | VariableRefSet |
| An interface for accessing a set of VariableRef elements. More... | |
| interface | RoleIterator |
| An interface allowing Role elements to be iterated. More... | |
| interface | RoleSet |
| An interface for accessing a set of Role elements. More... | |
| interface | ModelLoadedListener |
| An interface allowing notifications that model loading has completed to be delivered. More... | |
| interface | DocumentLoadedListener |
| An interface allowing notifications that document loading has completed to be delivered. More... | |
| interface | ModelLoader |
| An interface for loading a CellML model (from URL or string). More... | |
| interface | DOMURLLoader |
| A DOM specific interface for loading a Document. More... | |
| interface | DOMModelLoader |
| A DOM specific interface for loading a CellML model with more control. More... | |
| interface | CellMLBootstrap |
| A DOM specific interface that provides everything an application needs to bootstrap the CellML API. More... | |
Typedefs | |
| typedef dom::Element | ExtensionElement |
| typedef wstring | CellMLAttributeString |
| This holds attribute values for the XML attributes of elements in serialised CellML. | |
| typedef mathml_dom::MathMLElement | MathMLElement |
Enumerations | |
| enum | VariableInterface { INTERFACE_IN, INTERFACE_OUT, INTERFACE_NONE } |
| An enumeration representing the direction of the variable interface. More... | |
Detailed Description
This module contains a description of the CellML Application Programming Interface in the language-neutral IDL form.
Typedef Documentation
| typedef wstring cellml_api::CellMLAttributeString |
This holds attribute values for the XML attributes of elements in serialised CellML.
Character data in XML can be any Unicode character; the sequence of characters must conform to the rules of XML character data (which define escaping of reserved characters etc).
Definition at line 62 of file CellML_APISPEC.idl.
Definition at line 51 of file CellML_APISPEC.idl.
Definition at line 64 of file CellML_APISPEC.idl.
Enumeration Type Documentation
An enumeration representing the direction of the variable interface.
- Enumerator:
INTERFACE_IN The interface is in.
INTERFACE_OUT The interface is out.
INTERFACE_NONE No interface is defined.
Definition at line 928 of file CellML_APISPEC.idl.
