cellml_api::Unit Interface Reference

Interface to a <unit> element. More...

Inheritance diagram for cellml_api::Unit:

Collaboration diagram for cellml_api::Unit:

Public Attributes
attribute long	prefix
	The value of the prefix attribute in the unit element.
attribute double	multiplier
	The value of the multiplier attribute in the unit element.
attribute double	offset
	The value of the offset attribute in the unit element.
attribute double	exponent
	The value of the exponent attribute in unit element.
attribute CellMLAttributeString	units
	The name of the units attribute.
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

Interface to a <unit> element.

Definition at line 755 of file CellML_APISPEC.idl.

Member Data Documentation

attribute double cellml_api::Unit::exponent

The value of the exponent attribute in unit element.

Definition at line 778 of file CellML_APISPEC.idl.

attribute double cellml_api::Unit::multiplier

The value of the multiplier attribute in the unit element.

Definition at line 768 of file CellML_APISPEC.idl.

attribute double cellml_api::Unit::offset

The value of the offset attribute in the unit element.

Definition at line 773 of file CellML_APISPEC.idl.

attribute long cellml_api::Unit::prefix

The value of the prefix attribute in the unit element.

This is automatically converted to or from the text name of the SI prefix when converting to a DOM view.

Definition at line 763 of file CellML_APISPEC.idl.

attribute CellMLAttributeString cellml_api::Unit::units

The name of the units attribute.

Definition at line 783 of file CellML_APISPEC.idl.