Represents a <variable> element in a CellML document. More...

Inheritance diagram for cellml_api::CellMLVariable:

Collaboration diagram for cellml_api::CellMLVariable:

Public Attributes
attribute CellMLAttributeString	initialValue
	The initial value of this variable.
readonly attribute boolean	initialValueFromVariable
	Whether the initial value attribute is a number, or names a variable.
attribute CellMLVariable	initialValueVariable
	The variable named by the initial_value attribute.
attribute double	initialValueValue
	The initial value of the variable, as a double.
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.
readonly attribute interface_list	supported_interfaces
	Fetches all supported interfaces.

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.
UserData	getUserDataWithDefault (in wstring key, in UserData defval) raises (CellMLException)
	Retrieves user-supplied annotations previously set on this element, or the default value.
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 947 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 1014 of file CellML_APISPEC.idl.

readonly attribute CellMLVariableSet cellml_api::CellMLVariable::connectedVariables

The collection of all variables connected to this variable.

Definition at line 994 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 955 of file CellML_APISPEC.idl.

readonly attribute boolean cellml_api::CellMLVariable::initialValueFromVariable

Whether the initial value attribute is a number, or names a variable.

Returns: false if the initial_value attribute represents a number, and true otherwise.

Definition at line 962 of file CellML_APISPEC.idl.

attribute double cellml_api::CellMLVariable::initialValueValue

The initial value of the variable, as a double.

Exceptions

CellMLException If the initial_value attribute is malformed, missing, or refers to a variable.

Definition at line 979 of file CellML_APISPEC.idl.

attribute CellMLVariable cellml_api::CellMLVariable::initialValueVariable

The variable named by the initial_value attribute.

If the initial_value attribute does not name a variable found in the model, or there is no initial_value attribute, returns null. Note that this can happen even if initialValueFromVariable returns true, because the initial_value attribute might refer to a variable which doesn't (yet) exist in the component. Setting to null deletes the attribute.

Exceptions

CellMLException If set to a variable not in the same component.

Definition at line 972 of file CellML_APISPEC.idl.

attribute VariableInterface cellml_api::CellMLVariable::privateInterface

The private interface direction of this variable.

Definition at line 984 of file CellML_APISPEC.idl.

attribute VariableInterface cellml_api::CellMLVariable::publicInterface

The public interface direction of this variable.

Definition at line 989 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 1009 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 1027 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 1020 of file CellML_APISPEC.idl.

CellML API

cellml_api::CellMLVariable Interface Reference

Public Attributes

Additional Inherited Members

Detailed Description

Member Data Documentation

CellML API