import "IToiDiagnosticsDataModel.idl";
Public Member Functions | |
void | GetObject (in TToiObjectIdentifier objectId, out TToiObjectInfo infoObject) raises (TToiInvalidArgumentException) |
void | SetObject (in TToiObjectInfo infoObject) raises (TToiInvalidArgumentException, TToiPermissionDeniedException) |
void | SubscribeObject (in string address, in TToiObjectIdentifier objectId) raises (TToiInvalidArgumentException) |
void | UnsubscribeObject (in string address, in TToiObjectIdentifier objectId) raises (TToiInvalidArgumentException) |
void | ReleaseInstance () |
void | RegisterObserver (in IToiApplicationService::TToiApplicationId applicationId, in string address) raises (TToiInvalidArgumentException) |
void | ReleaseObserver (in string address) raises (TToiInvalidArgumentException) |
Classes | |
struct | TToiObjectInfo |
struct | TToiObjectParameter |
Public Types | |
typedef string | TToiObjectIdentifier |
typedef sequence < TToiObjectParameter > | TToiObjectParameterSequence |
typedef sequence < TToiObjectIdentifier > | TToiObjectIdentifierSequence |
typedef sequence< TToiObjectInfo > | TToiObjectInfoSequence |
typedef string IToiDiagnosticsDataModel::TToiObjectIdentifier |
Identifier for an object in the Data Model.
typedef sequence< TToiObjectIdentifier > IToiDiagnosticsDataModel::TToiObjectIdentifierSequence |
Sequence of object Identifiers.
typedef sequence< TToiObjectInfo > IToiDiagnosticsDataModel::TToiObjectInfoSequence |
Sequence of objects.
typedef sequence< TToiObjectParameter > IToiDiagnosticsDataModel::TToiObjectParameterSequence |
Sequence of parameters.
void IToiDiagnosticsDataModel::GetObject | ( | in TToiObjectIdentifier | objectId, | |
out TToiObjectInfo | infoObject | |||
) | raises (TToiInvalidArgumentException) |
This function returns a TToiObjectInfo corresponding to the given objectId.
objectId | The Id for the object |
infoObject | The TToiObjectInfo representing that object in the data model. |
TToiInvalidArgumentException | Raised if the specified object identifier is invalid. |
void IToiDiagnosticsDataModel::RegisterObserver | ( | in IToiApplicationService::TToiApplicationId | applicationId, | |
in string | address | |||
) | raises (TToiInvalidArgumentException) |
Register an observer of type IToiDiagnosticsDataModelObserver. The observer will receive events sent by this IToiDiagnosticsDataModel instance.
applicationId | The identifier of the observing application. | |
address | The address where the IToiDiagnosticsDataModel can find an IToiDiagnosticsDataModelObserver interface. |
TToiInvalidArgumentException | Raised if the specified address is invalid or if the application has already registered itself as an observer with the same address. |
void IToiDiagnosticsDataModel::ReleaseInstance | ( | ) |
This function releases the resources used by this instance. When this function returns all observers have also been released.
void IToiDiagnosticsDataModel::ReleaseObserver | ( | in string | address | ) | raises (TToiInvalidArgumentException) |
Release an observer previously registered with RegisterObserver.
address | The address where the IToiDiagnosticsDataModel can find the registered IToiDiagnosticsDataModelObserver interface. |
TToiInvalidArgumentException | Raised if the specified address is invalid. |
void IToiDiagnosticsDataModel::SetObject | ( | in TToiObjectInfo | infoObject | ) | raises (TToiInvalidArgumentException, TToiPermissionDeniedException) |
This function is used to set the parameters of an object in the data model.
infoObject | The object containing new parameter values. |
TToiInvalidArgumentException | Raised if the specified object indentifier is invalid. | |
TToiPermissionDeniedException | Raised if the parameters of the data model object cannot be set. |
void IToiDiagnosticsDataModel::SubscribeObject | ( | in string | address, | |
in TToiObjectIdentifier | objectId | |||
) | raises (TToiInvalidArgumentException) |
This function is used to register a IToiDiagnosticsDataModelObserver with the diagnostics framework to be notified of any changes to an object in the data model.
address | the address of the IToiDiagnosticsDataModelObserver | |
objectId | The object id that the application is interested in. |
TToiInvalidArgumentException | Raised if the specified object identifier is invalid. |
void IToiDiagnosticsDataModel::UnsubscribeObject | ( | in string | address, | |
in TToiObjectIdentifier | objectId | |||
) | raises (TToiInvalidArgumentException) |
This function is used to unregister a previously registered IToiDiagnosticsDataModelObserver.
address | the address of the IToiDiagnosticsDataModelObserver | |
objectId | The object id that the application is interested in. |
TToiInvalidArgumentException | Raised if the specified object identifier is invalid. Raised if the address is invalid. |