CellML API
CGRS::GenericInterface Interface Reference
CGRS::GenericInterface Interface Reference
A GenericModule represents a loaded module that provides generics support for a particular part of the CellML API. More...
Inheritance diagram for CGRS::GenericInterface:
Collaboration diagram for CGRS::GenericInterface:
Public Member Functions | |
| GenericInterface | getBase (in long aBaseNumber) raises (CGRSError) |
| Retrieves the aBaseNumber'th base interface for this interface. | |
| GenericAttribute | getAttributeByIndex (in long aAttributeNumber) raises (CGRSError) |
| Retrieves the aAttributeNumber'th attribute for this interface. | |
| GenericAttribute | getAttributeByName (in string aAttributeName) raises (CGRSError) |
| Retrieves an attribute on this interface by name. | |
| GenericMethod | getOperationByIndex (in long aOperationNumber) raises (CGRSError) |
| Retrieves the aOperationNumber'th attribute for this interface. | |
| GenericMethod | getOperationByName (in string aOperationName) raises (CGRSError) |
| Retrieves an operation on this interface by name. | |
 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 long | baseCount |
| The number of base interfaces underlying this interface. | |
| readonly attribute long | attributeCount |
| The number of attributes on this interface. | |
| readonly attribute long | operationCount |
| The number of operations on this interface. | |
| 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
A GenericModule represents a loaded module that provides generics support for a particular part of the CellML API.
Member Function Documentation
| GenericAttribute CGRS::GenericInterface::getAttributeByIndex | ( | in long | aAttributeNumber | ) | raises (CGRSError) |
Retrieves the aAttributeNumber'th attribute for this interface.
- Parameters
-
aAttributeNumber A zero-based index for the attribute.
- Returns
- A GenericAttribute corresponding to the attribute.
- Exceptions
-
CGRSError if the attribute number is negative or too high.
| GenericAttribute CGRS::GenericInterface::getAttributeByName | ( | in string | aAttributeName | ) | raises (CGRSError) |
Retrieves an attribute on this interface by name.
- Parameters
-
aAttributeName A name for the attribute.
- Returns
- A GenericAttribute corresponding to the attribute.
- Exceptions
-
CGRSError if no attribute exists with the specified name.
| GenericInterface CGRS::GenericInterface::getBase | ( | in long | aBaseNumber | ) | raises (CGRSError) |
Retrieves the aBaseNumber'th base interface for this interface.
- Parameters
-
aBaseNumber A zero-based index for the base.
- Returns
- A GenericInterface corresponding to the index.
- Exceptions
-
CGRSError if the base number is negative or too high.
| GenericMethod CGRS::GenericInterface::getOperationByIndex | ( | in long | aOperationNumber | ) | raises (CGRSError) |
Retrieves the aOperationNumber'th attribute for this interface.
- Parameters
-
aOperationNumber A zero-based index for the operation.
- Returns
- A GenericMethod corresponding to the operation.
- Exceptions
-
CGRSError if the operation number is negative or too high.
| GenericMethod CGRS::GenericInterface::getOperationByName | ( | in string | aOperationName | ) | raises (CGRSError) |
Retrieves an operation on this interface by name.
- Parameters
-
aOperationName A name for the operation.
- Returns
- A GenericMethod corresponding to the operation.
- Exceptions
-
CGRSError if no operation exists with the specified name.
Member Data Documentation
| readonly attribute long CGRS::GenericInterface::attributeCount |
| readonly attribute long CGRS::GenericInterface::baseCount |