TSensrvChannelInfo Class Reference

Link against: SensrvClient.lib

#include <sensrvchannelinfo.h>

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.

Dll sensrvutil.lib

Since:: S60 5.0


Public Member Functions
IMPORT_C	TSensrvChannelInfo ()
	Default Constructor.
IMPORT_C	TSensrvChannelInfo (TInt aContextType, TInt aQuantity, TSensrvChannelTypeId aChannelType, const TDesC8 &aLocation, const TDesC8 &aVendorId, TSensrvChannelDataTypeId aChannelDataTypeId)
	Constructor.
IMPORT_C	TSensrvChannelInfo (TSensrvChannelId aChannelId, TInt aContextType, TInt aQuantity, TSensrvChannelTypeId aChannelType, const TDesC8 &aLocation, const TDesC8 &aVendorId, TInt aDataItemSize, TSensrvChannelDataTypeId aChannelDataTypeId)
	Constructor.
IMPORT_C	TSensrvChannelInfo (const TSensrvChannelInfo &aChannelInfo)
	Copy constructor.
IMPORT_C TBool	IsMatch (const TSensrvChannelInfo &aInfo) const
	Checks if this instance matches supplied instance.
IMPORT_C TBool	IsComplete () const
	Checks that channel information in this object is complete.
Data Fields
TSensrvChannelId	iChannelId
	Channel Identifier.
TInt	iContextType
	Context type.
TInt	iQuantity
	Quantity.
TSensrvChannelTypeId	iChannelType
	Channel type identifier.
TBuf8< KSensrvLocationLength >	iLocation
	Location of the of the channel.
TBuf8< KSensrvVendorIdLength >	iVendorId
	Vendor name of the channel provider.
TInt	iDataItemSize
	Size of the data item delivered by the channel.
TSensrvChannelDataTypeId	iChannelDataTypeId
	Identifies the channel data type.

Constructor & Destructor Documentation

IMPORT_C TSensrvChannelInfo::TSensrvChannelInfo

(

)

Default Constructor.

Since:: S60 5.0

IMPORT_C TSensrvChannelInfo::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

Parameters:

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

See also:: TSensrvContextType
TSensrvQuantity

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

Constructor.

Since:: S60 5.0

Parameters:

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

See also:: TSensrvContextType
TSensrvQuantity

IMPORT_C TSensrvChannelInfo::TSensrvChannelInfo

(

const TSensrvChannelInfo &

aChannelInfo

)

Copy constructor.

Since:: S60 5.0

Parameters:

aChannelInfo

Instance to be copied

Member Function Documentation

IMPORT_C TBool TSensrvChannelInfo::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

Returns:: ETrue if channel information is complete.

IMPORT_C TBool TSensrvChannelInfo::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:

aInfo

Instance to be matched against this instance.

Returns:: ETrue if there is a match, otherwise EFalse

Field Documentation

TSensrvChannelDataTypeId TSensrvChannelInfo::iChannelDataTypeId

Identifies the channel data type.

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

TSensrvChannelId TSensrvChannelInfo::iChannelId

Channel Identifier.

TSensrvChannelTypeId TSensrvChannelInfo::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 TSensrvChannelInfo::iContextType

Context type.