cellml_api::RelationshipRef Interface Reference

Represents a relationship_ref element in a group element. More...

Inheritance diagram for cellml_api::RelationshipRef:

Collaboration diagram for cellml_api::RelationshipRef:

Public Member Functions
void	setRelationshipName (in CellMLAttributeString namespaceURI, in CellMLAttributeString name)
	Sets the namespace and relationship 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
attribute CellMLAttributeString	name
	The name of this relationship_ref, or the empty string if no such name is defined.
readonly attribute CellMLAttributeString	relationship
	The name of the relationship referenced by this element.
readonly attribute CellMLAttributeString	relationshipNamespace
	The namespace in which the relationship attribute belongs.
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

Represents a relationship_ref element in a group element.

Definition at line 1024 of file CellML_APISPEC.idl.

Member Function Documentation

void cellml_api::RelationshipRef::setRelationshipName	(	in CellMLAttributeString	namespaceURI,
		in CellMLAttributeString	name
	)

Sets the namespace and relationship name.

This will remove any other relationship attributes in any namespace.

Parameters

namespaceURI	The URI of the namespace
name	The name of the relationship.

Member Data Documentation

attribute CellMLAttributeString cellml_api::RelationshipRef::name

The name of this relationship_ref, or the empty string if no such name is defined.

Definition at line 1031 of file CellML_APISPEC.idl.

readonly attribute CellMLAttributeString cellml_api::RelationshipRef::relationship

The name of the relationship referenced by this element.

Definition at line 1036 of file CellML_APISPEC.idl.

readonly attribute CellMLAttributeString cellml_api::RelationshipRef::relationshipNamespace

The namespace in which the relationship attribute belongs.

Definition at line 1041 of file CellML_APISPEC.idl.