Collapse all Symbian^3 Application Developer Library

TBTNumericComparisonParams Class Reference

class TBTNumericComparisonParams : public TBTNotifierParams2

Secure simple pairing "Numeric Comparison" parameters. This class packages the parameters passed to a numeric comparison notifier.

Inherits from

TBTNumericComparisonParams
- TBTNotifierParams2

Public Member Functions
	TBTNumericComparisonParams (const TBTDevAddr &, const TDesC &, TUint32 , TComparisonScenario , TBool )
	TBTNumericComparisonParams ()
IMPORT_C TComparisonScenario	ComparisonScenario ()
IMPORT_C TBool	LocallyInitiated ()
IMPORT_C TUint32	NumericalValue ()

Inherited Functions
	TBTNotifierParams2::DeviceAddress()const
	TBTNotifierParams2::DeviceName()const
	TBTNotifierParams2::TBTNotifierParams2()
	TBTNotifierParams2::TBTNotifierParams2(const TBTDevAddr &,const TDesC &)

Public Member Enumerations
enum	TComparisonScenario { ERemoteCannotConfirm , ERemoteCanConfirm }

Private Attributes
TComparisonScenario	iComparisonScenario
TBool	iLocallyInitiated
TUint32	iNumericalValue
TUint32	iPadding1
TUint32	iPadding2

Constructor & Destructor Documentation

TBTNumericComparisonParams(const TBTDevAddr &, const TDesC &, TUint32, TComparisonScenario, TBool)

IMPORT_C	TBTNumericComparisonParams	(	const TBTDevAddr &	aDevAddr,
			const TDesC &	aDeviceName,
			TUint32	aNumericalValue,
			TComparisonScenario	aComparisonScenario,
			TBool	aLocallyInitiated
		)

Parameters

const TBTDevAddr & aDevAddr
const TDesC & aDeviceName
TUint32 aNumericalValue
TComparisonScenario aComparisonScenario
TBool aLocallyInitiated

TBTNumericComparisonParams()

IMPORT_C

TBTNumericComparisonParams

(

)

Default constructor. Required to allow the class to be packaged with the TPckg family of classes.

Member Functions Documentation

ComparisonScenario()

IMPORT_C TComparisonScenario

ComparisonScenario

(

)

const

Accessor for the enumeration that indicates the particular numeric comparison scenario that the notifier is indicating.

LocallyInitiated()

IMPORT_C TBool

LocallyInitiated

(

)

const

Accessor for indicating whether the numeric comparison process was initiated by a local request, or whether it was trigger by the remote device.

NumericalValue()

IMPORT_C TUint32

NumericalValue

(

)

const

Accessor for the 6 digit decimal numeric value to be used for comparison.

Member Enumerations Documentation

Enum TComparisonScenario

This represents the type of comparison that is being performed. It is intended to allow the UI to present the user of the device with suitable information to help them complete the pairing.

Enumerators

ERemoteCannotConfirm	Only the Symbian device can confirm the displayed numbers are the same.
ERemoteCanConfirm	Both devices can confirm that the displayed numbers are the same