cellml_services::AnnotationSet Interface Reference

A set of finite-lifetime annotations. More...

Inheritance diagram for cellml_services::AnnotationSet:

Collaboration diagram for cellml_services::AnnotationSet:

Public Member Functions
void	setStringAnnotation (in cellml_api::CellMLElement element, in wstring key, in wstring value)
	Saves a string on an object.
wstring	getStringAnnotation (in cellml_api::CellMLElement element, in wstring key)
	Retrieves a string annotation.
void	setObjectAnnotation (in cellml_api::CellMLElement element, in wstring key, in XPCOM::IObject value)
	Saves an object on an object.
XPCOM::IObject	getObjectAnnotation (in cellml_api::CellMLElement element, in wstring key)
	Retrieves an object annotation.
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 wstring	prefixURI
	Retrieves the unique URI used as a prefix for this annotation set.
Public Attributes inherited from XPCOM::IObject
readonly attribute string	objid
	Fetches the ID of the object.

Detailed Description

A set of finite-lifetime annotations.

The purpose of this interface is to allow annotations to be set throughout the life of a tool invocation or operation, but then to be all removed at the end (a similar concept to pooled memory management). All annotations set using this AnnotationSet will be removed when the AnnotationSet is destroyed. The service also allocates a unique prefix, allowing annotations to be done on a per-AnnotationSet basis - different sets of annotations will not interfere with each other.

Definition at line 51 of file AnnoTools.idl.

Member Function Documentation

XPCOM::IObject cellml_services::AnnotationSet::getObjectAnnotation	(	in cellml_api::CellMLElement	element,
		in wstring	key
	)

Retrieves an object annotation.

Parameters

element	The element to get the annotation from.
key	The key to get.

wstring cellml_services::AnnotationSet::getStringAnnotation	(	in cellml_api::CellMLElement	element,
		in wstring	key
	)

Retrieves a string annotation.

Parameters

element	The element to get the annotation from.
key	The key to get.

void cellml_services::AnnotationSet::setObjectAnnotation	(	in cellml_api::CellMLElement	element,
		in wstring	key,
		in XPCOM::IObject	value
	)

Saves an object on an object.

The annotation is specific to this AnnotationSet, and will be removed when the annotation set is destroyed.

Parameters

element	The element to annotate.
key	The key to set.
value	The value to set. Will replace any existing annotation from this annotation set with the same key.

void cellml_services::AnnotationSet::setStringAnnotation	(	in cellml_api::CellMLElement	element,
		in wstring	key,
		in wstring	value
	)

Saves a string on an object.

The annotation is specific to this AnnotationSet, and will be removed when the annotation set is destroyed.

Parameters

element	The element to annotate.
key	The key to set.
value	The value to set. Will replace any existing annotation with the same key.

Member Data Documentation

readonly attribute wstring cellml_services::AnnotationSet::prefixURI

Retrieves the unique URI used as a prefix for this annotation set.

Definition at line 57 of file AnnoTools.idl.