TPositionModuleInfo Class Reference

#include <lbscommon.h>

Link against: lbs.lib

class TPositionModuleInfo : public TPositionModuleInfoBase

Inherits from

TPositionModuleInfo
- TPositionModuleInfoBase
  - TPositionClassTypeBase

Public Member Type Definitions
typedef	TUint32 TCapabilities
typedef	TUint32 TDeviceLocation
typedef	TUint32 TTechnologyType

Protected Attributes
TCapabilities	iCapabilities
TDeviceLocation	iDeviceLocation
TBool	iIsAvailable
TPositionModuleId	iModuleId
TBuf< KPositionMaxModuleName >	iModuleName
TPositionQuality	iPosQuality
TFixedArray< TUint32, EPositionLastFamily >	iSupportedClassTypes
TTechnologyType	iTechnologyType
TVersion	iVersion

Public Member Enumerations
enum	_TCapabilities { ECapabilityNone, ECapabilityHorizontal, ECapabilityVertical, ECapabilitySpeed, ..., ECapabilityMedia }
enum	_TDeviceLocation { EDeviceUnknown, EDeviceInternal, EDeviceExternal }
enum	_TTechnologyType { ETechnologyUnknown, ETechnologyTerminal, ETechnologyNetwork, ETechnologyAssisted }

Public Member Functions
	TPositionModuleInfo()
IMPORT_C TCapabilities	Capabilities()
IMPORT_C TUint32	ClassesSupported(TPositionClassFamily)
IMPORT_C TDeviceLocation	DeviceLocation()
IMPORT_C void	GetModuleName(TDes &)
IMPORT_C void	GetPositionQuality(TPositionQuality &)
IMPORT_C TBool	IsAvailable()
IMPORT_C TPositionModuleId	ModuleId()
IMPORT_C void	SetCapabilities(TCapabilities)
IMPORT_C void	SetClassesSupported(TPositionClassFamily, TUint32)
IMPORT_C void	SetDeviceLocation(TDeviceLocation)
IMPORT_C void	SetIsAvailable(TBool)
IMPORT_C void	SetModuleId(TPositionModuleId)
IMPORT_C void	SetModuleName(const TDesC &)
IMPORT_C void	SetPositionQuality(const TPositionQuality &)
IMPORT_C void	SetTechnologyType(TTechnologyType)
IMPORT_C void	SetVersion(TVersion)
IMPORT_C TTechnologyType	TechnologyType()
IMPORT_C TVersion	Version()

Inherited Attributes
	TPositionClassTypeBase::iPosClassSize
	TPositionClassTypeBase::iPosClassType

Inherited Functions
	TPositionClassTypeBase::PositionClassSize()const
	TPositionClassTypeBase::PositionClassType()const
	TPositionClassTypeBase::TPositionClassTypeBase()
	TPositionModuleInfoBase::TPositionModuleInfoBase()

Detailed Description

The standard class for storing information on position modules

Member Type Definition Documentation

Typedef TCapabilities

typedef TUint32

TCapabilities

Position module capabilities

Typedef TDeviceLocation

typedef TUint32

TDeviceLocation

Device locations

Typedef TTechnologyType

typedef TUint32

TTechnologyType

Technology types

Member Attribute Documentation

iCapabilities

TCapabilities

iCapabilities

[protected]

The capabilities of this module

iDeviceLocation

TDeviceLocation

iDeviceLocation

[protected]

The location of the device associated with this module

iIsAvailable

TBool

iIsAvailable

[protected]

Whether or not the module is available

iModuleId

TPositionModuleId

iModuleId

[protected]

The module ID

iModuleName

TBuf< KPositionMaxModuleName >

iModuleName

[protected]

The module name

iPosQuality

TPositionQuality

iPosQuality

[protected]

The position quality

iSupportedClassTypes

TFixedArray< TUint32, EPositionLastFamily >

iSupportedClassTypes

[protected]

The array of supported classes for the different class types

iTechnologyType

TTechnologyType

iTechnologyType

[protected]

The technology type

iVersion

TVersion

iVersion

[protected]

The version of this module

Member Enumeration Documentation

Enum _TCapabilities

Module Capabilities

Enumerator	Value	Description
ECapabilityNone	0	No Capabilities
ECapabilityHorizontal	0x0001	Positioning modules with this capability will support the TPositionInfo class and are able to provide latitude and longitude related information
ECapabilityVertical	0x0002	Positioning modules with this capability will support the TPositionInfo class and are able to provide height related information
ECapabilitySpeed	0x0004	Positioning modules with this capability will support the TPositionCourseInfo class and are able to provide information related to the current horizontal speed
ECapabilityDirection	0x0008	Positioning modules with this capability will support the TPositionCourseInfo class and are able to provide heading related information
ECapabilitySatellite	0x0010	Positioning modules with this capability will support the TPositionSatelliteInfo class. Such a module will be able to return at least some satellite data - but the extent of the information could vary. Applications must ensure that any value returned is valid before it is used
ECapabilityCompass	0x0020	This value is reserved for future expansion. Positioning modules with this capability will be able to return information related to a magnetic compass. The API does not currently define an extended class that encapsulates this type of information
ECapabilityNmea	0x0040	This value is reserved for future expansion. Positioning modules with this capability will be able to return location information using NMEA formatted text strings. The API does not currently define an extended class that encapsulates this type of information
ECapabilityAddress	0x0080	This value is reserved for future expansion. Positioning modules with this capability will be able to return information related to the postal address of the current location
ECapabilityBuilding	0x0100	This value is reserved for future expansion. Positioning modules with this capability will be able to return the current position in terms of where within a building it is. For example, this may include the floor and the room name. The API does not currently define an extended class that encapsulates this type of information
ECapabilityMedia	0x0200	This value is reserved for future expansion. Positioning modules with this capability will be able to return provide a link to further information about the location. The standard mechanism is via a URL. The API does not currently define an extended class that encapsulates this type of information

Enum _TDeviceLocation

Device location

Enumerator	Value	Description
EDeviceUnknown	0	The positioning module is unaware of the hardware used to supply positioning information
EDeviceInternal	0x01	The positioning hardware is integral to the terminal
EDeviceExternal	0x02	The positioning hardware is separate from the terminal

Enum _TTechnologyType

Technology Type

Enumerator	Value	Description
ETechnologyUnknown	0	Indicates that the positioning module is unaware of the technology used to obtain position information
ETechnologyTerminal	0x01	The primary positioning technology is handset based. For example standard GPS
ETechnologyNetwork	0x02	The primary positioning technology is network based. For example, E-OTD
ETechnologyAssisted	0x04	The primary positioning mechanism receives assistance in some form. Generally to obtain a quicker or more accurate fix

Constructor & Destructor Documentation

TPositionModuleInfo ( )

IMPORT_C

TPositionModuleInfo

(

)

Default constructor for TPositionModuleInfo

Member Function Documentation

Capabilities ( )

IMPORT_C TCapabilities

Capabilities

(

)

const

Capabilities

Returns: The capabilities of this module

ClassesSupported ( TPositionClassFamily )

IMPORT_C TUint32

ClassesSupported

(

TPositionClassFamily

aClassType

)

const

Classes Supported

Parameter	Description
aClassType	Classes Supported

Returns: The classes supported

DeviceLocation ( )

IMPORT_C TDeviceLocation

DeviceLocation

(

)

const

Device Location

Returns: The location of the positioning device associated with this module

GetModuleName ( TDes & )

IMPORT_C void

GetModuleName

(

TDes &

aModuleName

)

const

Gets Module Name

Parameter	Description
aModuleName	The descriptor where the module's name will be placed

GetPositionQuality ( TPositionQuality & )

IMPORT_C void

GetPositionQuality

(

TPositionQuality &

aPosQuality

)

const

Gets Position Quality

Parameter	Description
aPosQuality	The quality of the position

IsAvailable ( )

IMPORT_C TBool

IsAvailable

(

)

const

Returns Availablity

Returns: Whether or not this module is available

ModuleId ( )

IMPORT_C TPositionModuleId

ModuleId

(

)

const

Module Id

Returns: The module ID

SetCapabilities ( TCapabilities )

IMPORT_C void

SetCapabilities

(

TCapabilities

aDeviceCapabilities

)

Sets capabilities

Parameter	Description
aDeviceCapabilities	Bitfield of the capabilities of this module to set

SetClassesSupported ( TPositionClassFamily, TUint32 )

IMPORT_C void	SetClassesSupported	(	TPositionClassFamily	aClassType,
			TUint32	aSupportedClasses
		)

Sets supported classes

Parameter	Description
aClassType	The class type
aSupportedClasses	The supported classes

SetDeviceLocation ( TDeviceLocation )

IMPORT_C void

SetDeviceLocation

(

TDeviceLocation

aDeviceLocation

)

Sets device location

Parameter	Description
aDeviceLocation	The positioning device location to set

SetIsAvailable ( TBool )

IMPORT_C void

SetIsAvailable

(

TBool

aIsAvailable

)

Sets module availablity

Parameter	Description
aIsAvailable	Whether or not the module is available for use

SetModuleId ( TPositionModuleId )

IMPORT_C void

SetModuleId

(

TPositionModuleId

aModuleId

)

Sets module Id

Parameter	Description
aModuleId	The module ID to set

SetModuleName ( const TDesC & )

IMPORT_C void

SetModuleName

(

const TDesC &

aModuleName

)

Sets module name

Parameter	Description
aModuleName	The module name to set

SetPositionQuality ( const TPositionQuality & )

IMPORT_C void

SetPositionQuality

(

const TPositionQuality &

aPosQuality

)

Sets position quality

Parameter	Description
aPosQuality	The position quality to set

SetTechnologyType ( TTechnologyType )

IMPORT_C void

SetTechnologyType

(

TTechnologyType

aTechnologyType

)

Sets technology type

Parameter	Description
aTechnologyType	The technology type to set

SetVersion ( TVersion )

IMPORT_C void

SetVersion

(

TVersion

aVersion

)

Sets Version

Parameter	Description
aVersion	The version to set

TechnologyType ( )

IMPORT_C TTechnologyType

TechnologyType

(

)

const

Technology Type

Returns: The technology type

Version ( )

IMPORT_C TVersion

Version

(

)

const

Module Version

Returns: The version of the module