TSensrvChannelInfo Class Reference

class TSensrvChannelInfo

The TSensrvChannelInfo class is a data class that holds information about a sensor channel.

It also provides simple helper methods that allow users to determine if the class is complete and if one instance of this class matches another.

sensrvutil.lib S60 5.0

Constructor & Destructor Documentation

TSensrvChannelInfo()

IMPORT_CTSensrvChannelInfo()

Default Constructor

S60 5.0

TSensrvChannelInfo(TInt, TInt, TSensrvChannelTypeId, const TDesC8 &, const TDesC8 &, TSensrvChannelDataTypeId)

IMPORT_CTSensrvChannelInfo(TIntaContextType,
TIntaQuantity,
TSensrvChannelTypeIdaChannelType,
const TDesC8 &aLocation,
const TDesC8 &aVendorId,
TSensrvChannelDataTypeIdaChannelDataTypeId
)

Constructor

This constructor is for use with CSensrvChannelFinder::FindChannelsL(). It sets the ChannelId and DataItemSize to zero.

S60 5.0

TSensrvContextType

TSensrvQuantity

Parameters

TInt aContextTypeChannel context type. Set to a value from TSensrvContextType.
TInt aQuantityChannel quantity. Set to a value from TSensrvQuantity.
TSensrvChannelTypeId aChannelTypeChannel type id. This is a uid.
const TDesC8 & aLocationChannel physical location.
const TDesC8 & aVendorIdChannel vendor name.
TSensrvChannelDataTypeId aChannelDataTypeIdChannel data type Id. This is a uid.

TSensrvChannelInfo(TSensrvChannelId, TInt, TInt, TSensrvChannelTypeId, const TDesC8 &, const TDesC8 &, TInt, TSensrvChannelDataTypeId)

IMPORT_CTSensrvChannelInfo(TSensrvChannelIdaChannelId,
TIntaContextType,
TIntaQuantity,
TSensrvChannelTypeIdaChannelType,
const TDesC8 &aLocation,
const TDesC8 &aVendorId,
TIntaDataItemSize,
TSensrvChannelDataTypeIdaChannelDataTypeId
)

Constructor

S60 5.0

TSensrvContextType

TSensrvQuantity

Parameters

TSensrvChannelId aChannelIdChannel identifier
TInt aContextTypeChannel context type. Set to a value from TSensrvContextType.
TInt aQuantityChannel quantity. Set to a value from TSensrvQuantity.
TSensrvChannelTypeId aChannelTypeChannel type id. This is a uid.
const TDesC8 & aLocationChannel physical location.
const TDesC8 & aVendorIdChannel vendor name.
TInt aDataItemSizeData item size for channel specific data
TSensrvChannelDataTypeId aChannelDataTypeIdChannel data type Id. This is a uid.

TSensrvChannelInfo(const TSensrvChannelInfo &)

IMPORT_CTSensrvChannelInfo(const TSensrvChannelInfo &aChannelInfo)

Copy constructor

S60 5.0

Parameters

const TSensrvChannelInfo & aChannelInfoInstance to be copied

Member Functions Documentation

IsComplete()

IMPORT_C TBoolIsComplete()const

Checks that channel information in this object is complete. Complete means no zero or empty fields. Channel Id, Data Item Size and the Reserved fields are ignored.

S60 5.0

ETrue if channel information is complete.

IsMatch(const TSensrvChannelInfo &)

IMPORT_C TBoolIsMatch(const TSensrvChannelInfo &aInfo)const

Checks if this instance matches supplied instance. Fields that are zero or empty are ignored. Channel Id, Data Item Size and Reserved fields are ignored.

S60 5.0

ETrue if there is a match, otherwise EFalse

Parameters

const TSensrvChannelInfo & aInfoInstance to be matched against this instance.

Member Data Documentation

TSensrvChannelDataTypeId iChannelDataTypeId

TSensrvChannelDataTypeId iChannelDataTypeId

Identifies the channel data type. This value is a uid and is unique among all channels. See sensor channel specific header files.

TSensrvChannelId iChannelId

TSensrvChannelId iChannelId

Channel Identifier

TSensrvChannelTypeId iChannelType

TSensrvChannelTypeId iChannelType

Channel type identifier

Identifies the channel type and therefore the content of the channel. This value is a uid and is unique among all channels. See sensor channel specific header files.

TInt iContextType

TInt iContextType

Context type TSensrvContextType

TInt iDataItemSize

TInt iDataItemSize

Size of the data item delivered by the channel

TBuf8< KSensrvLocationLength > iLocation

TBuf8< KSensrvLocationLength >iLocation

Location of the of the channel. This is a free format string

TInt iQuantity

TInt iQuantity

Quantity TSensrvQuantity

TInt iReserved

TInt iReserved[private]

TInt iReserved2

TInt iReserved2[private]

TInt iReserved3

TInt iReserved3[private]

TBuf8< KSensrvVendorIdLength > iVendorId

TBuf8< KSensrvVendorIdLength >iVendorId

Vendor name of the channel provider. This is a free format string and is not to be confused with Vendor Id unique Uid's.