CellML API
cellml_api::CellMLVariable Interface Reference
Represents a <variable> element in a CellML document. More...
Public Attributes | |
| attribute CellMLAttributeString | initialValue |
| The initial value of this variable. | |
| attribute VariableInterface | privateInterface |
| The private interface direction of this variable. | |
| attribute VariableInterface | publicInterface |
| The public interface direction of this variable. | |
| readonly attribute CellMLVariableSet | connectedVariables |
| The collection of all variables connected to this variable. | |
| readonly attribute CellMLVariable | sourceVariable |
| The source variable is always a variable on which f(v) holds, and is this variable, or a variable which is(directly or indirectly) connected to this variable. | |
| readonly attribute CellMLAttributeString | componentName |
| The name of the component containing this CellMLVariable. | |
| attribute CellMLAttributeString | unitsName |
| The name of the units this CellMLVariable is in. | |
| attribute Units | unitsElement |
| The Units element which is referenced from this variable. | |
 Public Attributes inherited from cellml_api::NamedCellMLElement | |
| attribute CellMLAttributeString | name |
| The name associated with this CellML element. | |
| Public Attributes inherited from cellml_api::CellMLElement | |
| readonly attribute CellMLAttributeString | cellmlVersion |
| The CellML version that this element corresponds to. | |
| attribute CellMLAttributeString | cmetaId |
| This element's cmeta id (which may be defined on any CellML element). | |
| readonly attribute ExtensionElementList | extensionElements |
| The collection of extension elements associated with this CellML element. | |
| readonly attribute CellMLElementSet | childElements |
| Get a list of all the child CellMLElements in this element. | |
| readonly attribute CellMLElement | parentElement |
| The parent element of this element... | |
| readonly attribute Model | modelElement |
| The underlying model element. | |
| readonly attribute ExtensionAttributeSet | extensionAttributes |
| Fetches the set of all extension attributes, which can be used to iterate through the extension attributes. | |
| Public Attributes inherited from XPCOM::IObject | |
| readonly attribute string | objid |
| Fetches the ID of the object. | |
Additional Inherited Members | |
| Public Member Functions inherited from cellml_api::CellMLElement | |
| void | insertExtensionElementAfter (in ExtensionElement marker, in ExtensionElement newEl) |
| Insert an element into the collection of extension elements without disturbing the order of the existing elements. | |
| void | appendExtensionElement (in ExtensionElement x) |
| Equivalent to insertExtensionElementAfter(last extension element, x). | |
| void | prependExtensionElement (in ExtensionElement x) |
| Equivalent to insertExtensionElementAfter(nil, x) | |
| void | removeExtensionElement (in ExtensionElement x) |
| Remove an extension element. | |
| void | replaceExtensionElement (in ExtensionElement x, in ExtensionElement y) |
| Find an extension element, and if it is found, replace it with another element. | |
| void | clearExtensionElements () |
| Remove all extension elements from this element. | |
| void | addElement (in CellMLElement x) raises (CellMLException) |
| Add a CellML element to this element. | |
| void | removeElement (in CellMLElement x) |
| Removes a CellML element from this element. | |
| void | replaceElement (in CellMLElement x, in CellMLElement y) raises (CellMLException) |
| Removes a CellML element from this element, and replaces it with another CellML element. | |
| void | removeByName (in CellMLAttributeString type, in CellMLAttributeString name) |
| Remove a CellML element by name, or do nothing if that element is not found. | |
| void | setUserData (in wstring key, in UserData data) |
| Sets user-supplied annotations on this element. | |
| UserData | getUserData (in wstring key) raises (CellMLException) |
| Retrieves user-supplied annotations previously set on this element. | |
| CellMLElement | clone (in boolean deep) |
| Clones a CellMLElement, and optionally all children. | |
| wstring | getExtensionAttributeNS (in wstring ns, in wstring localName) |
| Fetches an extension attribute. | |
| void | setExtensionAttributeNS (in wstring ns, in wstring qualifiedName, in wstring value) |
| Sets an extension attribute (adding it if it doesn't already exist, otherwise replacing it). | |
| void | removeExtensionAttributeNS (in wstring ns, in wstring localName) |
| Removes an extension attribute. | |
Detailed Description
Represents a <variable> element in a CellML document.
Definition at line 928 of file CellML_APISPEC.idl.
Member Data Documentation
| readonly attribute CellMLAttributeString cellml_api::CellMLVariable::componentName |
The name of the component containing this CellMLVariable.
Definition at line 971 of file CellML_APISPEC.idl.
| readonly attribute CellMLVariableSet cellml_api::CellMLVariable::connectedVariables |
The collection of all variables connected to this variable.
Definition at line 951 of file CellML_APISPEC.idl.
| attribute CellMLAttributeString cellml_api::CellMLVariable::initialValue |
The initial value of this variable.
If there is no initial value, will return the empty string. Setting to the empty string will delete any initial_value attribute present.
Definition at line 936 of file CellML_APISPEC.idl.
| attribute VariableInterface cellml_api::CellMLVariable::privateInterface |
The private interface direction of this variable.
Definition at line 941 of file CellML_APISPEC.idl.
| attribute VariableInterface cellml_api::CellMLVariable::publicInterface |
The public interface direction of this variable.
Definition at line 946 of file CellML_APISPEC.idl.
| readonly attribute CellMLVariable cellml_api::CellMLVariable::sourceVariable |
The source variable is always a variable on which f(v) holds, and is this variable, or a variable which is(directly or indirectly) connected to this variable.
If no such variable exists, sourceVariable is nil. This must work correctly across import boundaries, if those imports have been fully instantiated. f(v) is defined as meaning (v.public_interface == INTERFACE_OUT || v.public_interface == INTERFACE_NONE) && (v.private_interface == INTERFACE_OUT || v.private_interface == INTERFACE_NONE)
Definition at line 966 of file CellML_APISPEC.idl.
| attribute Units cellml_api::CellMLVariable::unitsElement |
The Units element which is referenced from this variable.
This must be in either the component or the model. It will be an ImportUnits for units imported into the component.
Definition at line 984 of file CellML_APISPEC.idl.
| attribute CellMLAttributeString cellml_api::CellMLVariable::unitsName |
The name of the units this CellMLVariable is in.
This is the value of the units attribute.
Definition at line 977 of file CellML_APISPEC.idl.
