ToiScanner Interface Reference

---

Description

The ToiScanner 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 "ToiScanner.idl";

Inheritance diagram for ToiScanner:

List of all members.

Public Member Functions
void	clear () raises (TToiInvalidPreconditionException)
void	startScan (in ToiOperationManager::TToiOperationId operationId, in TToiStoreMode storeMode) raises (TToiInvalidArgumentException, TToiInvalidPreconditionException)
void	releaseInstance ()
Public Attributes
Operation properties
The operation properties defined for scan operations. See ToiOperationManager for more info.
const ToiOperationManager::TToiPropertyId	OP_PROPERTY_SERVICES_FOUND = 1
TToiStoreMode
const TToiStoreMode	STORE_MODE_OVERWRITE = 0
const TToiStoreMode	STORE_MODE_UPDATE = 1
Public Types
typedef long	TToiStoreMode

---

Member Typedef Documentation

typedef long ToiScanner::TToiStoreMode

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

---

Member Function Documentation

void ToiScanner::clear

(

)

raises (TToiInvalidPreconditionException)

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

Exceptions:

TToiInvalidPreconditionException

Raised if a scan is active.

void ToiScanner::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 ToiScanner::startScan	(	in ToiOperationManager::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 ToiOperationOperationResultEvent call with the operation result ToiOperationManager::OP_RESULT_NONE, then the application can get the number of found services from ToiOperationManager::TToiPropertySequence. The property for this is identified by id ToiScanner::OP_PROPERTY_SERVICES_FOUND. Only when the state in ToiOperationManagerOperationInfo reach OPERATION_COMPLETED, the application can get channel info via ToiChannelService.

Calling ToiOperationManager::cancelOperation() will immediately stop an ongoing channel scan. The found services since StartScan() are not saved to permanent storage. Calling ToiOperationManager::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 ToiOperationManager retrieved from ToiFrontendService.
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

const ToiOperationManager::TToiPropertyId ToiScanner::OP_PROPERTY_SERVICES_FOUND = 1

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

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

const TToiStoreMode ToiScanner::STORE_MODE_OVERWRITE = 0

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

This constant can also be accessed from toi.consts.ToiScanner.STORE_MODE_OVERWRITE.

const TToiStoreMode ToiScanner::STORE_MODE_UPDATE = 1

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

This constant can also be accessed from toi.consts.ToiScanner.STORE_MODE_UPDATE.