IToiDiagnosticsDataModel Interface Reference


Description

Technical Preview:
This interface is a TECHNICAL PREVIEW, it may change. This interface represents the data model of all the diagnostics information present on the device.

import "IToiDiagnosticsDataModel.idl";

List of all members.

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< TToiObjectInfoTToiObjectInfoSequence

Member Typedef Documentation

Identifier for an object in the Data Model.

Sequence of object Identifiers.

Sequence of objects.


Member Function Documentation

void IToiDiagnosticsDataModel::GetObject ( in TToiObjectIdentifier  objectId,
out TToiObjectInfo  infoObject 
) raises (TToiInvalidArgumentException)

This function returns a TToiObjectInfo corresponding to the given objectId.

Parameters:
objectId The Id for the object
Return values:
infoObject The TToiObjectInfo representing that object in the data model.
Exceptions:
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.

Parameters:
applicationId The identifier of the observing application.
address The address where the IToiDiagnosticsDataModel can find an IToiDiagnosticsDataModelObserver interface.
Exceptions:
TToiInvalidArgumentException Raised if the specified address is invalid or if the application has already registered itself as an observer with the same address.
See also:
IToiDiagnosticsDataModelObserver
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.

Parameters:
address The address where the IToiDiagnosticsDataModel can find the registered IToiDiagnosticsDataModelObserver interface.
Exceptions:
TToiInvalidArgumentException Raised if the specified address is invalid.
See also:
IToiDiagnosticsDataModelObserver
void IToiDiagnosticsDataModel::SetObject ( in TToiObjectInfo  infoObject  )  raises (TToiInvalidArgumentException, TToiPermissionDeniedException)

This function is used to set the parameters of an object in the data model.

Parameters:
infoObject The object containing new parameter values.
Exceptions:
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.

Parameters:
address the address of the IToiDiagnosticsDataModelObserver
objectId The object id that the application is interested in.
Exceptions:
TToiInvalidArgumentException Raised if the specified object identifier is invalid.
See also:
UnsubscribeObject()
void IToiDiagnosticsDataModel::UnsubscribeObject ( in string  address,
in TToiObjectIdentifier  objectId 
) raises (TToiInvalidArgumentException)

This function is used to unregister a previously registered IToiDiagnosticsDataModelObserver.

Parameters:
address the address of the IToiDiagnosticsDataModelObserver
objectId The object id that the application is interested in.
Exceptions:
TToiInvalidArgumentException Raised if the specified object identifier is invalid. Raised if the address is invalid.
See also:
SubscribeObject()