IToiScanner Interface Reference


Description

Technical Preview:
This interface is a TECHNICAL PREVIEW, it may change. The IToiScanner interface is the base interface for all other scanner interfaces. It contains control functions used for scanning, but the control parameters specific to different types of scans are set in interfaces derived from this.

import "IToiScanner.idl";

List of all members.

Public Member Functions

void Clear () raises (TToiInvalidPreconditionException)
void StartScan (in IToiOperationManager::TToiOperationId operationId, in TToiStoreMode storeMode) raises (TToiInvalidArgumentException, TToiInvalidPreconditionException)
void ReleaseInstance ()

Public Attributes

Operation properties

The operation properties defined for scan operations. See IToiOperationManager for more info.

const
IToiOperationManager::TToiPropertyId 
OP_PROPERTY_SERVICES_FOUND = 1

Public Types

enum  TToiStoreMode { STORE_MODE_OVERWRITE, STORE_MODE_UPDATE }

Member Enumeration Documentation

This structure defines the store mode that is used when the service information is written to the permanent storage.

Enumerator:
STORE_MODE_OVERWRITE 

Remove all previous channels for this modulation system and replace them with the ones found.

STORE_MODE_UPDATE 

Update the existing channels, and add the new channels to the permanent storage.


Member Function Documentation

void IToiScanner::Clear (  )  raises (TToiInvalidPreconditionException)

Clear all the scan parameters set by the derived scan interface.

Exceptions:
TToiInvalidPreconditionException Raised if a scan is active.
void IToiScanner::ReleaseInstance (  ) 

This function releases the resources used by this instance. Upon return this object will no longer be available and must not be called.

void IToiScanner::StartScan ( in IToiOperationManager::TToiOperationId  operationId,
in TToiStoreMode  storeMode 
) raises (TToiInvalidArgumentException, TToiInvalidPreconditionException)

Starts a scan based on the parameters set by the functions of the derived scan interface. The found channel information is stored into permanent storage based on the store mode once the scan process is completed.

When the application receives a IToiOperationObserver::OnOperationResult() call with the operation result IToiOperationManager::OP_RESULT_NONE, then the application can get the number of found services from IToiOperationManager::TToiPropertySequence. The property for this is identified by id OP_PROPERTY_SERVICES_FOUND. Only when the state in IToiOperationManager::TToiOperationInfo reach OPERATION_COMPLETED, the application can get channel info via IToiChannelService.

Calling IToiOperationManager::CancelOperation() will immediately stop an ongoing channel scan. The found services since StartScan() are not saved to permanent storage. Calling IToiOperationManager::ReleaseOperation() will remove the operation identified by operationId. If a scan is in progress, it will immediatly stop and the found services since StartScan() are not saved to permanent storage.

Parameters:
operationId The operation identifier created by IToiOperationManager retrieved from IToiFrontendService.
storeMode The store mode used for saving the found service information.
Exceptions:
TToiInvalidArgumentException Raised if the function was called with invalid arguments.
TToiInvalidPreconditionException Raised if no scan parameters are set or one scan is active.

Member Data Documentation

This property indicates the number of services found since the start of the scan, See StartScan().

This constant can also be accessed from toi.consts.IToiScanner.OP_PROPERTY_SERVICES_FOUND.