TPositionModuleInfo Class Reference

#include <lbscommon.h>

Link against: lbs.lib

class TPositionModuleInfo : public TPositionModuleInfoBase, public TPositionModuleInfoBase
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 TCapabilitiesCapabilities()
IMPORT_C TUint32ClassesSupported(TPositionClassFamily)
IMPORT_C TDeviceLocationDeviceLocation()
IMPORT_C voidGetModuleName(TDes &)
IMPORT_C voidGetPositionQuality(TPositionQuality &)
IMPORT_C TBoolIsAvailable()
IMPORT_C TPositionModuleIdModuleId()
IMPORT_C voidSetCapabilities(TCapabilities)
IMPORT_C voidSetClassesSupported(TPositionClassFamily, TUint32)
IMPORT_C voidSetDeviceLocation(TDeviceLocation)
IMPORT_C voidSetIsAvailable(TBool)
IMPORT_C voidSetModuleId(TPositionModuleId)
IMPORT_C voidSetModuleName(const TDesC &)
IMPORT_C voidSetPositionQuality(const TPositionQuality &)
IMPORT_C voidSetTechnologyType(TTechnologyType)
IMPORT_C voidSetVersion(TVersion)
IMPORT_C TTechnologyTypeTechnologyType()
IMPORT_C TVersionVersion()
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

EnumeratorValueDescription
ECapabilityNone0

No Capabilities

ECapabilityHorizontal0x0001

Positioning modules with this capability will support the TPositionInfo class and are able to provide latitude and longitude related information

ECapabilityVertical0x0002

Positioning modules with this capability will support the TPositionInfo class and are able to provide height related information

ECapabilitySpeed0x0004

Positioning modules with this capability will support the TPositionCourseInfo class and are able to provide information related to the current horizontal speed

ECapabilityDirection0x0008

Positioning modules with this capability will support the TPositionCourseInfo class and are able to provide heading related information

ECapabilitySatellite0x0010

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

ECapabilityCompass0x0020

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

ECapabilityNmea0x0040

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

ECapabilityAddress0x0080

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

ECapabilityBuilding0x0100

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

ECapabilityMedia0x0200

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

EnumeratorValueDescription
EDeviceUnknown0

The positioning module is unaware of the hardware used to supply positioning information

EDeviceInternal0x01

The positioning hardware is integral to the terminal

EDeviceExternal0x02

The positioning hardware is separate from the terminal

Enum _TTechnologyType

Technology Type

EnumeratorValueDescription
ETechnologyUnknown0

Indicates that the positioning module is unaware of the technology used to obtain position information

ETechnologyTerminal0x01

The primary positioning technology is handset based. For example standard GPS

ETechnologyNetwork0x02

The primary positioning technology is network based. For example, E-OTD

ETechnologyAssisted0x04

The primary positioning mechanism receives assistance in some form. Generally to obtain a quicker or more accurate fix

Constructor & Destructor Documentation

TPositionModuleInfo ( )

IMPORT_CTPositionModuleInfo()

Default constructor for TPositionModuleInfo

Member Function Documentation

Capabilities ( )

IMPORT_C TCapabilitiesCapabilities()const

Capabilities

Return Value
The capabilities of this module

ClassesSupported ( TPositionClassFamily )

IMPORT_C TUint32ClassesSupported(TPositionClassFamilyaClassType)const

Classes Supported

Parameters
aClassTypeClasses Supported
Return Value
The classes supported

DeviceLocation ( )

IMPORT_C TDeviceLocationDeviceLocation()const

Device Location

Return Value
The location of the positioning device associated with this module

GetModuleName ( TDes & )

IMPORT_C voidGetModuleName(TDes &aModuleName)const

Gets Module Name

Parameters
aModuleNameThe descriptor where the module's name will be placed

GetPositionQuality ( TPositionQuality & )

IMPORT_C voidGetPositionQuality(TPositionQuality &aPosQuality)const

Gets Position Quality

Parameters
aPosQualityThe quality of the position

IsAvailable ( )

IMPORT_C TBoolIsAvailable()const

Returns Availablity

Return Value
Whether or not this module is available

ModuleId ( )

IMPORT_C TPositionModuleIdModuleId()const

Module Id

Return Value
The module ID

SetCapabilities ( TCapabilities )

IMPORT_C voidSetCapabilities(TCapabilitiesaDeviceCapabilities)

Sets capabilities

Parameters
aDeviceCapabilitiesBitfield of the capabilities of this module to set

SetClassesSupported ( TPositionClassFamily, TUint32 )

IMPORT_C voidSetClassesSupported(TPositionClassFamilyaClassType,
TUint32aSupportedClasses
)

Sets supported classes

Parameters
aClassTypeThe class type
aSupportedClassesThe supported classes

SetDeviceLocation ( TDeviceLocation )

IMPORT_C voidSetDeviceLocation(TDeviceLocationaDeviceLocation)

Sets device location

Parameters
aDeviceLocationThe positioning device location to set

SetIsAvailable ( TBool )

IMPORT_C voidSetIsAvailable(TBoolaIsAvailable)

Sets module availablity

Parameters
aIsAvailableWhether or not the module is available for use

SetModuleId ( TPositionModuleId )

IMPORT_C voidSetModuleId(TPositionModuleIdaModuleId)

Sets module Id

Parameters
aModuleIdThe module ID to set

SetModuleName ( const TDesC & )

IMPORT_C voidSetModuleName(const TDesC &aModuleName)

Sets module name

Parameters
aModuleNameThe module name to set

SetPositionQuality ( const TPositionQuality & )

IMPORT_C voidSetPositionQuality(const TPositionQuality &aPosQuality)

Sets position quality

Parameters
aPosQualityThe position quality to set

SetTechnologyType ( TTechnologyType )

IMPORT_C voidSetTechnologyType(TTechnologyTypeaTechnologyType)

Sets technology type

Parameters
aTechnologyTypeThe technology type to set

SetVersion ( TVersion )

IMPORT_C voidSetVersion(TVersionaVersion)

Sets Version

Parameters
aVersionThe version to set

TechnologyType ( )

IMPORT_C TTechnologyTypeTechnologyType()const

Technology Type

Return Value
The technology type

Version ( )

IMPORT_C TVersionVersion()const

Module Version

Return Value
The version of the module