TBTDevAddr Class Reference

class TBTDevAddr

48-bit bluetooth device address. Each bluetooth device has a unique address built into the hardware, which is represented by this class. Used for identifying remote addresses. The interface operates in a big-endian manner -- e.g. addr[0] refers to the most significant byte of the address. This is the same ordering as the addresses would naturally be written down on paper.

Public Member Functions
TBTDevAddr ()
TBTDevAddr (const TInt64 &)
TBTDevAddr (const TDesC8 &)
IMPORT_C TPtr8 Des ()
IMPORT_C const TPtrC8 Des ()
IMPORT_C void GetReadable ( TDes &)
IMPORT_C void GetReadable ( TDes &, const TDesC &, const TDesC &, const TDesC &)
IMPORT_C void Reset ()
IMPORT_C TInt SetReadable (const TDesC &)
IMPORT_C TBool operator!= (const TBTDevAddr &)
IMPORT_C TBool operator<= (const TBTDevAddr &)
IMPORT_C TBool operator== (const TBTDevAddr &)
IMPORT_C const TUint8 & operator[] ( TInt )
IMPORT_C TUint8 & operator[] ( TInt )
Private Attributes
TFixedArray < TUint8 , KBTDevAddrSize > iAddr
TUint16 iPadding

Constructor & Destructor Documentation

TBTDevAddr()

IMPORT_C TBTDevAddr ( )

Default constructor. The address is initialised to 0.

TBTDevAddr(const TInt64 &)

IMPORT_C TBTDevAddr ( const TInt64 & aInt )

Constructs a device address from a TInt64.

The function panics if the most significant 16 bits of aInt are non-zero, as device addresses are 48 bits in size.

Parameters

const TInt64 & aInt Value for device address.

TBTDevAddr(const TDesC8 &)

IMPORT_C TBTDevAddr ( const TDesC8 & aDes )

Constructs a device address from a data buffer.

The buffer is copied directly into the object. The function panics if aDes does not have a length of 6 bytes (48 bits).

Parameters

const TDesC8 & aDes Data buffer for device address

Member Functions Documentation

Des()

IMPORT_C TPtr8 Des ( )

Access value as a bigendian descriptor.

Des()

IMPORT_C const TPtrC8 Des ( ) const

Access value as a bigendian descriptor.

GetReadable(TDes &)

IMPORT_C void GetReadable ( TDes & aDest ) const

Extract the Bluetooth device address into a human-readable format, in aDest.

Output is in hexadecimal bigendian format, with no padding characters.

Note: aDest must be large enough to hold the entire output, or else a a panic will occur.

Parameters

TDes & aDest Descriptor where result is placed.

GetReadable(TDes &, const TDesC &, const TDesC &, const TDesC &)

IMPORT_C void GetReadable ( TDes & aDest,
const TDesC & aPrepend,
const TDesC & aByteSeperator,
const TDesC & aAppend
) const

Extract the Bluetooth device address into a human-readable format, in aDest.

Output is in hexadecimal bigendian format, with optional padding characters.

Note: aDest must be large enough to hold the entire output, or else a a panic will occur.

Parameters

TDes & aDest Descriptor where result is placed.
const TDesC & aPrepend Added onto front of output.
const TDesC & aByteSeperator Inserted between each byte of address.
const TDesC & aAppend Added onto end of output.

Reset()

IMPORT_C void Reset ( )

Reset the data contained within the object.

SetReadable(const TDesC &)

IMPORT_C TInt SetReadable ( const TDesC & aSource )

Convert Readable string into a dev addr.

Address may have leading space and "0x" characters.

Parameters

const TDesC & aSource Readable Hex representation of address

operator!=(const TBTDevAddr &)

IMPORT_C TBool operator!= ( const TBTDevAddr & aAddr ) const

Inequality operator.

Parameters

const TBTDevAddr & aAddr The device address to compare to this object.

operator<=(const TBTDevAddr &)

IMPORT_C TBool operator<= ( const TBTDevAddr & aAddr ) const

Less than operator.

Parameters

const TBTDevAddr & aAddr The device address to compare to this object.

operator==(const TBTDevAddr &)

IMPORT_C TBool operator== ( const TBTDevAddr & aAddr ) const

Comparison operator.

Parameters

const TBTDevAddr & aAddr The device address to compare to this object.

operator[](TInt)

IMPORT_C const TUint8 & operator[] ( TInt aIndex ) const

Access a single element of the address.

Parameters

TInt aIndex The index of the element to access.

operator[](TInt)

IMPORT_C TUint8 & operator[] ( TInt aIndex )

Access a single element of the address.

Parameters

TInt aIndex The index of the element to access.

Member Data Documentation

TFixedArray< TUint8, KBTDevAddrSize > iAddr

TFixedArray < TUint8 , KBTDevAddrSize > iAddr [private]

TUint16 iPadding

TUint16 iPadding [private]