TSensrvChannelInfo Class Reference

#include <sensrvchannelinfo.h>

Link against: sensrvutil.lib

class TSensrvChannelInfo

Detailed Description

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.

Since
S60 5.0

Member Attribute Documentation

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.

iChannelId

TSensrvChannelId iChannelId

Channel Identifier

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.

iContextType

TInt iContextType

Context type

See also: TSensrvContextType

iDataItemSize

TInt iDataItemSize

Size of the data item delivered by the channel

iLocation

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

iQuantity

TInt iQuantity

Quantity

See also: TSensrvQuantity

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.

Constructor & Destructor Documentation

TSensrvChannelInfo ( )

IMPORT_CTSensrvChannelInfo()

Default Constructor

Since
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.

Since
S60 5.0

See also: TSensrvContextType TSensrvQuantity

ParameterDescription
aContextTypeChannel context type. Set to a value from TSensrvContextType.
aQuantityChannel quantity. Set to a value from TSensrvQuantity.
aChannelTypeChannel type id. This is a uid.
aLocationChannel physical location.
aVendorIdChannel vendor name.
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

Since
S60 5.0

See also: TSensrvContextType TSensrvQuantity

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

TSensrvChannelInfo ( const TSensrvChannelInfo & )

IMPORT_CTSensrvChannelInfo(const TSensrvChannelInfo &aChannelInfo)

Copy constructor

Since
S60 5.0
ParameterDescription
aChannelInfoInstance to be copied

Member Function 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.

Since
S60 5.0

Returns: 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.

Since
S60 5.0
ParameterDescription
aInfoInstance to be matched against this instance.

Returns: ETrue if there is a match, otherwise EFalse