cellml_api::Reaction Interface Reference

An interface to a <reaction> element. More...

Inheritance diagram for cellml_api::Reaction:

Collaboration diagram for cellml_api::Reaction:

Public Member Functions
VariableRef	getVariableRef (in wstring varName, in boolean create)
	Fetches a VariableRef by the variable name.
Role	getRoleByDeltaVariable (in wstring varName)
	Fetches a Role by the delta variable name.
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 XPCOM::IObject
void	add_ref ()
	Called to indicate that some code is keeping an owning reference to the object.
oneway void	release_ref ()
	Removes a reference to an object which was created by some other means (e.g.
IObject	query_interface (in utf8string id)
	Returns an IObject of the same implementation, which supports a specific interface.

Public Attributes
readonly attribute VariableRefSet	variableReferences
	A collection of all the reactants involved in this reaction.
attribute boolean	reversible
	Whether or not the reaction is reversible.
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.

Detailed Description

An interface to a <reaction> element.

Definition at line 1193 of file CellML_APISPEC.idl.

Member Function Documentation

Role cellml_api::Reaction::getRoleByDeltaVariable

(

in wstring

varName

)

Fetches a Role by the delta variable name.

Parameters

varName

The name of the delta variable, within this component.

Returns

The Role corresponding to this delta variable. If no such Role exists, then NULL is returned.

VariableRef cellml_api::Reaction::getVariableRef	(	in wstring	varName,
		in boolean	create
	)

Fetches a VariableRef by the variable name.

Parameters

varName	The name of the variable, within this component.
create	Whether or not to create a VariableRef if not found.

Returns

The variable reference corresponding to this variable. If no such VariableRef exists, then: i) If create is true, a new one is created and added to this reaction. ii) If create is false, NULL is returned.

Member Data Documentation

attribute boolean cellml_api::Reaction::reversible

Whether or not the reaction is reversible.

May be yes, no, or the empty string(if the attribute is absent).

Definition at line 1205 of file CellML_APISPEC.idl.

readonly attribute VariableRefSet cellml_api::Reaction::variableReferences

A collection of all the reactants involved in this reaction.

Definition at line 1199 of file CellML_APISPEC.idl.