CellML API
cellml_api::MapComponents Interface Reference
An interface the map_components element. More...


Public Attributes | |
attribute CellMLAttributeString | firstComponentName |
The name of the first component. | |
attribute CellMLAttributeString | secondComponentName |
The name of the second component. | |
attribute CellMLComponent | firstComponent |
The first component. | |
attribute CellMLComponent | secondComponent |
The second component. | |
![]() | |
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. | |
![]() | |
readonly attribute string | objid |
Fetches the ID of the object. |
Additional Inherited Members | |
![]() | |
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
An interface the map_components element.
Definition at line 1106 of file CellML_APISPEC.idl.
Member Data Documentation
attribute CellMLComponent cellml_api::MapComponents::firstComponent |
The first component.
This component shall be the component definition if imports have been instantiated, and otherwise shall be the ImportComponent.
Definition at line 1127 of file CellML_APISPEC.idl.
attribute CellMLAttributeString cellml_api::MapComponents::firstComponentName |
The name of the first component.
The returned name shall be the same name as found in the component_1 attribute(that is, the implementation shall not translate the name of imported components).
Definition at line 1114 of file CellML_APISPEC.idl.
attribute CellMLComponent cellml_api::MapComponents::secondComponent |
The second component.
This component shall be the component definition if imports have been instantiated, and otherwise shall be the ImportComponent.
Definition at line 1133 of file CellML_APISPEC.idl.
attribute CellMLAttributeString cellml_api::MapComponents::secondComponentName |
The name of the second component.
The returned name shall be the same name as found in the component_2 attribute(that is, the implementation shall not translate the name of imported components).
Definition at line 1121 of file CellML_APISPEC.idl.