CGRS::GenericsService Interface Reference

The GenericsService is the top-level object used for working with the CellML API using the generic interface. More...

Inheritance diagram for CGRS::GenericsService:

Collaboration diagram for CGRS::GenericsService:

Public Member Functions
void	loadGenericModule (in string aModulePath) raises (CGRSError)
	Loads a generics module (a module specifically produced to be used with the generics code, rather than an ordinary CellML API module).
GenericValue	getBootstrapByName (in string aBootstrapName) raises (CGRSError)
	Retrieves a generic bootstrap by name.
GenericInterface	getInterfaceByName (in string aInterfaceName) raises (CGRSError)
	Retrieves a generic interface by name.
StringValue	makeString (in string val)
	Creates a string value from a string.
WStringValue	makeWString (in wstring val)
	Creates a wide string value from a wide string.
ShortValue	makeShort (in short val)
	Creates a short value from a short.
LongValue	makeLong (in long val)
	Creates a long value from a long.
LongLongValue	makeLongLong (in long long val)
	Creates a long long value from a long long.
UShortValue	makeUShort (in unsigned short val)
	Creates an unsigned short value from an unsigned short.
ULongValue	makeULong (in unsigned long val)
	Creates an unsigned long value from an unsigned long.
ULongLongValue	makeULongLong (in unsigned long long val)
	Creates an unsigned long long value from an unsigned long.
FloatValue	makeFloat (in float val)
	Creates a float value from a float.
DoubleValue	makeDouble (in double val)
	Creates a double value from a double.
BooleanValue	makeBoolean (in boolean val)
	Creates a boolean value from a boolean.
CharValue	makeChar (in char val)
	Creates a character value from a char.
OctetValue	makeOctet (in octet val)
	Creates an octet value from an octet.
SequenceValue	makeSequence (in GenericType innerType)
	Creates a sequence value from a sequence.
EnumValue	makeEnumFromString (in EnumType etype, in string name)
	Creates an enum value from an enum.
EnumValue	makeEnumFromIndex (in EnumType etype, in long index)
	Creates an enum value from an index.
GenericValue	makeObject (in XPCOM::IObject value)
	Creates an object value from an object.
GenericValue	makeVoid ()
	Creates a void value...
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.

Additional Inherited Members
Public Attributes inherited from XPCOM::IObject
readonly attribute string	objid
	Fetches the ID of the object.
readonly attribute interface_list	supported_interfaces
	Fetches all supported interfaces.

Detailed Description

The GenericsService is the top-level object used for working with the CellML API using the generic interface.

Definition at line 47 of file CGRS.idl.

Member Function Documentation

GenericValue CGRS::GenericsService::getBootstrapByName

(

in string

aBootstrapName

)

raises (CGRSError)

Retrieves a generic bootstrap by name.

Parameters

aBootstrapName

The name of the bootstrap to retrieve.

Returns

A GenericValue for the bootstrap. CGRSError if the bootstrap cannot be found.

GenericInterface CGRS::GenericsService::getInterfaceByName

(

in string

aInterfaceName

)

raises (CGRSError)

Retrieves a generic interface by name.

Parameters

aInterfaceName

The name of the interface to retrieve.

Returns

A GenericInterface for the interface. CGRSError if the interface cannot be found.

void CGRS::GenericsService::loadGenericModule

(

in string

aModulePath

)

raises (CGRSError)

Loads a generics module (a module specifically produced to be used with the generics code, rather than an ordinary CellML API module).

Once the module has been loaded, subsequent interface and bootstrap lookups will include that module.

Parameters

aModulePath

The path from which to load the module. CGRSError If the module cannot be loaded.

BooleanValue CGRS::GenericsService::makeBoolean

(

in boolean

val

)

Creates a boolean value from a boolean.

CharValue CGRS::GenericsService::makeChar

(

in char

val

)

Creates a character value from a char.

DoubleValue CGRS::GenericsService::makeDouble

(

in double

val

)

Creates a double value from a double.

EnumValue CGRS::GenericsService::makeEnumFromIndex	(	in EnumType	etype,
		in long	index
	)

Creates an enum value from an index.

EnumValue CGRS::GenericsService::makeEnumFromString	(	in EnumType	etype,
		in string	name
	)

Creates an enum value from an enum.

FloatValue CGRS::GenericsService::makeFloat

(

in float

val

)

Creates a float value from a float.

LongValue CGRS::GenericsService::makeLong

(

in long

val

)

Creates a long value from a long.

LongLongValue CGRS::GenericsService::makeLongLong

(

in long long

val

)

Creates a long long value from a long long.

GenericValue CGRS::GenericsService::makeObject

(

in XPCOM::IObject

value

)

Creates an object value from an object.

OctetValue CGRS::GenericsService::makeOctet

(

in octet

val

)

Creates an octet value from an octet.

SequenceValue CGRS::GenericsService::makeSequence

(

in GenericType

innerType

)

Creates a sequence value from a sequence.

ShortValue CGRS::GenericsService::makeShort

(

in short

val

)

Creates a short value from a short.

StringValue CGRS::GenericsService::makeString

(

in string

val

)

Creates a string value from a string.

ULongValue CGRS::GenericsService::makeULong

(

in unsigned long

val

)

Creates an unsigned long value from an unsigned long.

ULongLongValue CGRS::GenericsService::makeULongLong

(

in unsigned long long

val

)

Creates an unsigned long long value from an unsigned long.

UShortValue CGRS::GenericsService::makeUShort

(

in unsigned short

val

)

Creates an unsigned short value from an unsigned short.

GenericValue CGRS::GenericsService::makeVoid

(

)

Creates a void value...

WStringValue CGRS::GenericsService::makeWString

(

in wstring

val

)

Creates a wide string value from a wide string.