Collapse all Symbian^3 Application Developer Library

TReportTranslator Class Reference

class TReportTranslator

HID report translator

Allows a device driver to extract data items from a device report, based on the results of the report descriptor parser stage (at device connection)

generichid.lib

Since: S60 v5.0

Public Member Functions
	TReportTranslator (const TDesC8 &, const CField *)
IMPORT_C TInt	Count ()
IMPORT_C TInt	GetUsageId ( TInt &, TInt )
IMPORT_C TInt	GetValue ( TInt &, TInt , TInt )
IMPORT_C TInt	RawValueL ( TInt )
IMPORT_C TInt	UsageIdL ( TInt )
IMPORT_C TInt	ValueL ( TInt , TInt )

Private Attributes
const TDesC8 &	iData
const CField *	iField

Constructor & Destructor Documentation

TReportTranslator(const TDesC8 &, const CField *)

IMPORT_C	TReportTranslator	(	const TDesC8 &	aData,
			const CField *	aField
		)

Constructor.

Since: S60 v5.0

Parameters

const TDesC8 & aData	Data to be extracted
const CField * aField	HID field

Member Functions Documentation

Count()

IMPORT_C TInt

Count

(

)

const

Gets the number of controls in the field.

Since: S60 v5.0

GetUsageId(TInt &, TInt)

IMPORT_C TInt	GetUsageId	(	TInt &	aUsageId,
			TInt	aIndex
		)	const

Gets the usage ID at a given index in an array field. For variable fields, if the logical value of the control at the given index is non- zero, returns the usage ID of the control, otherwise returns zero.

Since: S60 v5.0

Parameters

TInt & aUsageId	Reference to variable to receive the usage ID.
TInt aIndex	Index in the array to read.

GetValue(TInt &, TInt, TInt)

IMPORT_C TInt	GetValue	(	TInt &	aValue,
			TInt	aUsageId,
			TInt	aControlOffset = 0
		)	const

For variable fields, reads the logical value of the control with the given usage ID. For arrays, searches for the usage ID and gives the value as ETrue if found and EFalse if not.

Since: S60 v5.0

Parameters

TInt & aValue	Reference to variable to receive the value read from the field.
TInt aUsageId	Usage ID of the control to read.
TInt aControlOffset = 0	Which control to read when more than one have the same usage ID.

RawValueL(TInt)

IMPORT_C TInt

RawValueL

(

TInt

aIndex

)

const

Gets the logical value at a given index in a field. Leaves if an error occurs.

Since: S60 v5.0

Parameters

TInt aIndex

Index in the field to read.

UsageIdL(TInt)

IMPORT_C TInt

UsageIdL

(

TInt

aIndex

)

const

Alternate version of the above method for convenience. Returns the usage ID directly and leaves if an error occurs.

Since: S60 v5.0

Parameters

TInt aIndex

Index in the array to read.

ValueL(TInt, TInt)

IMPORT_C TInt	ValueL	(	TInt	aUsageId,
			TInt	aControlOffset = 0
		)	const

Alternate version of the above method for convenience. Returns the value read directly and leaves if an error occurs.

Since: S60 v5.0

Parameters

TInt aUsageId	Usage ID of the control to read.
TInt aControlOffset = 0	Which control to read when more than one have the same usage ID.

Member Data Documentation

const TDesC8 & iData

const TDesC8 &

iData

[private]

Data to be extracted

const CField * iField

const CField *

iField

[private]

HID field Not own.