cellml_api::MapVariables Interface Reference

An interface the map_variables element. More...

Inheritance diagram for cellml_api::MapVariables:

Collaboration diagram for cellml_api::MapVariables:

Public Attributes
attribute CellMLAttributeString	firstVariableName
	The name of the first variable.
attribute CellMLAttributeString	secondVariableName
	The name of the second variable.
attribute CellMLVariable	firstVariable
	The first variable.
attribute CellMLVariable	secondVariable
	The second variable.
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

An interface the map_variables element.

Definition at line 1140 of file CellML_APISPEC.idl.

Member Data Documentation

attribute CellMLVariable cellml_api::MapVariables::firstVariable

The first variable.

If this has already been added to a Connection, it must refer to the same Component as firstComponent(if it is set). If the component in the MapComponents has not been set, this implicitly sets it. If this has not been added to the Connection, the checks are performed at the time it is added.

Definition at line 1174 of file CellML_APISPEC.idl.

attribute CellMLAttributeString cellml_api::MapVariables::firstVariableName

The name of the first variable.

The variable name is interpreted only in the context of MapComponents, and so may only be read or set after the MapVariables is added to a Connection, and the Connection has in turn been added to a model. It also requires that the component name has already been set. CellMLException if the MapVariables has not been added to a Connection, or the Connection has not been added to the Model.

Definition at line 1153 of file CellML_APISPEC.idl.

attribute CellMLVariable cellml_api::MapVariables::secondVariable

The second variable.

If this has already been added to a Connection, it must refer to the same Component as secondComponent(if it is set). If the component in the MapComponents has not been set, this implicitly sets it. If this has not been added to the Connection, the checks are performed at the time it is added.

Definition at line 1183 of file CellML_APISPEC.idl.

attribute CellMLAttributeString cellml_api::MapVariables::secondVariableName

The name of the second variable.

The variable name is interpreted only in the context of MapComponents, and so may only be read or set after the MapVariables is added to a Connection, and the Connection has in turn been added to a model. It also requires that the component name has already been set. CellMLException if the MapVariables has not been added to a Connection, or the Connection has not been added to the Model.

Definition at line 1165 of file CellML_APISPEC.idl.