Collapse all Symbian^3 Product Developer Library

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

Since: S60 5.0

Public Member Functions
	TSensrvChannelInfo()
	TSensrvChannelInfo(TInt, TInt, TSensrvChannelTypeId, const TDesC8 &, const TDesC8 &, TSensrvChannelDataTypeId)
	TSensrvChannelInfo(TSensrvChannelId, TInt, TInt, TSensrvChannelTypeId, const TDesC8 &, const TDesC8 &, TInt, TSensrvChannelDataTypeId)
	TSensrvChannelInfo(const TSensrvChannelInfo &)
IMPORT_C TBool	IsComplete()
IMPORT_C TBool	IsMatch(const TSensrvChannelInfo &)

Public Attributes
TSensrvChannelDataTypeId	iChannelDataTypeId
TSensrvChannelId	iChannelId
TSensrvChannelTypeId	iChannelType
TInt	iContextType
TInt	iDataItemSize
TBuf8< KSensrvLocationLength >	iLocation
TInt	iQuantity
TBuf8< KSensrvVendorIdLength >	iVendorId

Private Attributes
TInt	iReserved
TInt	iReserved2
TInt	iReserved3

Constructor & Destructor Documentation

TSensrvChannelInfo()

IMPORT_C

TSensrvChannelInfo

(

)

Default Constructor

Since: S60 5.0

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

IMPORT_C	TSensrvChannelInfo	(	TInt	aContextType,
			TInt	aQuantity,
			TSensrvChannelTypeId	aChannelType,
			const TDesC8 &	aLocation,
			const TDesC8 &	aVendorId,
			TSensrvChannelDataTypeId	aChannelDataTypeId
		)

Constructor

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

Since: S60 5.0

TSensrvContextType TSensrvQuantity

Parameters

TInt aContextType	Channel context type. Set to a value from TSensrvContextType.
TInt aQuantity	Channel quantity. Set to a value from TSensrvQuantity.
TSensrvChannelTypeId aChannelType	Channel type id. This is a uid.
const TDesC8 & aLocation	Channel physical location.
const TDesC8 & aVendorId	Channel vendor name.
TSensrvChannelDataTypeId aChannelDataTypeId	Channel data type Id. This is a uid.

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

IMPORT_C	TSensrvChannelInfo	(	TSensrvChannelId	aChannelId,
			TInt	aContextType,
			TInt	aQuantity,
			TSensrvChannelTypeId	aChannelType,
			const TDesC8 &	aLocation,
			const TDesC8 &	aVendorId,
			TInt	aDataItemSize,
			TSensrvChannelDataTypeId	aChannelDataTypeId
		)

Constructor

Since: S60 5.0

TSensrvContextType TSensrvQuantity

Parameters

TSensrvChannelId aChannelId	Channel identifier
TInt aContextType	Channel context type. Set to a value from TSensrvContextType.
TInt aQuantity	Channel quantity. Set to a value from TSensrvQuantity.
TSensrvChannelTypeId aChannelType	Channel type id. This is a uid.
const TDesC8 & aLocation	Channel physical location.
const TDesC8 & aVendorId	Channel vendor name.
TInt aDataItemSize	Data item size for channel specific data
TSensrvChannelDataTypeId aChannelDataTypeId	Channel data type Id. This is a uid.

TSensrvChannelInfo(const TSensrvChannelInfo &)

IMPORT_C

TSensrvChannelInfo

(

const TSensrvChannelInfo &

aChannelInfo

)

Copy constructor

Since: S60 5.0

Parameters

const TSensrvChannelInfo & aChannelInfo

Instance to be copied

Member Functions Documentation

IsComplete()

IMPORT_C TBool

IsComplete

(

)

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

IsMatch(const TSensrvChannelInfo &)

IMPORT_C TBool

IsMatch

(

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

Parameters

const TSensrvChannelInfo & aInfo

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