cellml_api::Role Interface Reference

An interface to the <role> element. More...

Inheritance diagram for cellml_api::Role:

Collaboration diagram for cellml_api::Role:

Public Types
enum	RoleType {   REACTANT, PRODUCT, RATE, CATALYST,   ACTIVATOR, INHIBITOR, MODIFIER }
enum	DirectionType { FORWARD, REVERSE, BOTH }

Public Attributes
attribute RoleType	variableRole
	The role this variable plays.
attribute DirectionType	direction
	The direction of the reaction for which this role applies.
attribute double	stoichiometry
	The stoichiometry for this role.
attribute CellMLVariable	deltaVariable
	The variable represented by the delta_variable attribute.
attribute wstring	deltaVariableName
	The name of the variable represented by the delta_variable 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.
Public Attributes inherited from cellml_api::MathContainer
readonly attribute MathList	math
	The set of all math defined here.

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.
Public Member Functions inherited from cellml_api::MathContainer
void	addMath (in MathMLElement x) raises (CellMLException)
	Add an element to this collection.
void	removeMath (in MathMLElement x) raises (CellMLException)
	Remove an element from this collection.
void	replaceMath (in MathMLElement x, in MathMLElement y)
	Find an element in this collection, and if it is found, replace it with another element.
void	clearMath ()
	Remove all elements in this collection.

Detailed Description

An interface to the <role> element.

Definition at line 1256 of file CellML_APISPEC.idl.

Member Enumeration Documentation

enum cellml_api::Role::DirectionType

Enumerator:

FORWARD
REVERSE
BOTH

Definition at line 1264 of file CellML_APISPEC.idl.

enum cellml_api::Role::RoleType

Enumerator:

REACTANT
PRODUCT
RATE
CATALYST
ACTIVATOR
INHIBITOR
MODIFIER

Definition at line 1259 of file CellML_APISPEC.idl.

Member Data Documentation

attribute CellMLVariable cellml_api::Role::deltaVariable

The variable represented by the delta_variable attribute.

Definition at line 1287 of file CellML_APISPEC.idl.

attribute wstring cellml_api::Role::deltaVariableName

The name of the variable represented by the delta_variable attribute.

Definition at line 1292 of file CellML_APISPEC.idl.

attribute DirectionType cellml_api::Role::direction

The direction of the reaction for which this role applies.

Definition at line 1277 of file CellML_APISPEC.idl.

attribute double cellml_api::Role::stoichiometry

The stoichiometry for this role.

Definition at line 1282 of file CellML_APISPEC.idl.

attribute RoleType cellml_api::Role::variableRole

The role this variable plays.

Definition at line 1272 of file CellML_APISPEC.idl.