cellml_api::CellMLImport Interface Reference

This interface represents a CellML import element. More...

Inheritance diagram for cellml_api::CellMLImport:

Collaboration diagram for cellml_api::CellMLImport:

Public Member Functions
void	instantiate ()
	Causes the model referenced by the href attribute to be loaded using the same model loader used to load this model.
void	asyncInstantiate (in ImportInstantiationListener listener)
	Causes the model referenced by the href attribute to be asynchronously loaded using the same model loader used to load this model.
void	instantiateFromText (in dom::DOMString xmlText) raises (CellMLException)
	Causes this import to be instantiated from text.
void	uninstantiate ()
	Causes the model to be uninstantiated, so that it can be re-instantiated in the future.
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 URI	xlinkHref
	The URI in the xlink:href attribute.
readonly attribute ImportComponentSet	components
	The collection of all <component> elements inside this element.
readonly attribute ImportUnitsSet	units
	The collection of all <units> elements inside this element.
readonly attribute ConnectionSet	importedConnections
	The collection of all connections defined in the import or in components which are imported by the import (and so on) and which involve only the imported component(s) or other components beneath the same imported component(s) in the encapsulation hierarchy.
readonly attribute boolean	wasInstantiated
	Returns true if instantiate has previously been called on this import, or false otherwise.
readonly attribute unsigned long	uniqueIdentifier
	A number that, within the parent model, uniquely represents the CellMLImport.
readonly attribute Model	importedModel
	Returns NULL if imports have not been fully instantiated.
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

This interface represents a CellML import element.

Definition at line 790 of file CellML_APISPEC.idl.

Member Function Documentation

void cellml_api::CellMLImport::asyncInstantiate

(

in ImportInstantiationListener

listener

)

Causes the model referenced by the href attribute to be asynchronously loaded using the same model loader used to load this model.

Parameters

listener

The listener to load the model with.

void cellml_api::CellMLImport::instantiate

(

)

Causes the model referenced by the href attribute to be loaded using the same model loader used to load this model.

void cellml_api::CellMLImport::instantiateFromText

(

in dom::DOMString

xmlText

)

raises (CellMLException)

Causes this import to be instantiated from text.

Parameters

xmlText

The serialised XML document for the import. CellMLException if xmlText is not valid.

void cellml_api::CellMLImport::uninstantiate

(

)

Causes the model to be uninstantiated, so that it can be re-instantiated in the future.

Member Data Documentation

readonly attribute ImportComponentSet cellml_api::CellMLImport::components

The collection of all <component> elements inside this element.

Definition at line 808 of file CellML_APISPEC.idl.

readonly attribute ConnectionSet cellml_api::CellMLImport::importedConnections

The collection of all connections defined in the import or in components which are imported by the import (and so on) and which involve only the imported component(s) or other components beneath the same imported component(s) in the encapsulation hierarchy.

Definition at line 821 of file CellML_APISPEC.idl.

readonly attribute Model cellml_api::CellMLImport::importedModel

Returns NULL if imports have not been fully instantiated.

Otherwise returns the imported Model corresponding to this CellMLImport.

Definition at line 864 of file CellML_APISPEC.idl.

readonly attribute unsigned long cellml_api::CellMLImport::uniqueIdentifier

A number that, within the parent model, uniquely represents the CellMLImport.

Definition at line 857 of file CellML_APISPEC.idl.

readonly attribute ImportUnitsSet cellml_api::CellMLImport::units

The collection of all <units> elements inside this element.

Definition at line 813 of file CellML_APISPEC.idl.

readonly attribute boolean cellml_api::CellMLImport::wasInstantiated

Returns true if instantiate has previously been called on this import, or false otherwise.

Note that a call to fullyInstantiateImports() on a model which is an ancestor of this one in the import tree shall be treated as if it were a call to instantiate() on all imports. A successful asyncInstantiate or instantiateFromText call also causes this to return true.

Definition at line 852 of file CellML_APISPEC.idl.

readonly attribute URI cellml_api::CellMLImport::xlinkHref

The URI in the xlink:href attribute.

Changing the URL in the xlinkHref on an instantiated import will cause the import to become uninstantiated. If there are any iterators(of a kind which is required to return elements from more than one model) which were created from the sets prior to changing xlinkHref, an implementation may choose to continue to provide elements from the previously instantiated import. Applications must not rely upon the behaviour of any particular implementation in this case.

Definition at line 803 of file CellML_APISPEC.idl.