TPositionModuleInfo Class Reference

class TPositionModuleInfo : public TPositionModuleInfoBase

The standard class for storing information on position modules

Inherits from

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 Functions
TPositionClassTypeBase::PositionClassSize()const
TPositionClassTypeBase::PositionClassType()const
TPositionClassTypeBase::TPositionClassTypeBase()
TPositionModuleInfoBase::TPositionModuleInfoBase()
Public Member Enumerations
enum_TCapabilities {
ECapabilityNone = 0, ECapabilityHorizontal = 0x0001, ECapabilityVertical = 0x0002, ECapabilitySpeed = 0x0004, ECapabilityDirection = 0x0008, ECapabilitySatellite = 0x0010, ECapabilityCompass = 0x0020, ECapabilityNmea = 0x0040, ECapabilityAddress = 0x0080, ECapabilityBuilding = 0x0100, ECapabilityMedia = 0x0200
}
enum_TDeviceLocation { EDeviceUnknown = 0, EDeviceInternal = 0x01, EDeviceExternal = 0x02 }
enum_TTechnologyType { ETechnologyUnknown = 0, ETechnologyTerminal = 0x01, ETechnologyNetwork = 0x02, ETechnologyAssisted = 0x04 }
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
Private Attributes
TUint8 iReserved
Inherited Attributes
TPositionClassTypeBase::iPosClassSize
TPositionClassTypeBase::iPosClassType

Constructor & Destructor Documentation

TPositionModuleInfo()

IMPORT_CTPositionModuleInfo()

Member Functions Documentation

Capabilities()

IMPORT_C TCapabilitiesCapabilities()const

ClassesSupported(TPositionClassFamily)

IMPORT_C TUint32ClassesSupported(TPositionClassFamilyaClassType)const

Parameters

TPositionClassFamily aClassType

DeviceLocation()

IMPORT_C TDeviceLocationDeviceLocation()const

GetModuleName(TDes &)

IMPORT_C voidGetModuleName(TDes &aModuleName)const

Parameters

TDes & aModuleName

GetPositionQuality(TPositionQuality &)

IMPORT_C voidGetPositionQuality(TPositionQuality &aPosQuality)const

Parameters

TPositionQuality & aPosQuality

IsAvailable()

IMPORT_C TBoolIsAvailable()const

ModuleId()

IMPORT_C TPositionModuleIdModuleId()const

SetCapabilities(TCapabilities)

IMPORT_C voidSetCapabilities(TCapabilitiesaDeviceCapabilities)

Parameters

TCapabilities aDeviceCapabilities

SetClassesSupported(TPositionClassFamily, TUint32)

IMPORT_C voidSetClassesSupported(TPositionClassFamilyaClassType,
TUint32aSupportedClasses
)

Parameters

TPositionClassFamily aClassType
TUint32 aSupportedClasses

SetDeviceLocation(TDeviceLocation)

IMPORT_C voidSetDeviceLocation(TDeviceLocationaDeviceLocation)

Parameters

TDeviceLocation aDeviceLocation

SetIsAvailable(TBool)

IMPORT_C voidSetIsAvailable(TBoolaIsAvailable)

Parameters

TBool aIsAvailable

SetModuleId(TPositionModuleId)

IMPORT_C voidSetModuleId(TPositionModuleIdaModuleId)

Parameters

TPositionModuleId aModuleId

SetModuleName(const TDesC &)

IMPORT_C voidSetModuleName(const TDesC &aModuleName)

Parameters

const TDesC & aModuleName

SetPositionQuality(const TPositionQuality &)

IMPORT_C voidSetPositionQuality(const TPositionQuality &aPosQuality)

Parameters

const TPositionQuality & aPosQuality

SetTechnologyType(TTechnologyType)

IMPORT_C voidSetTechnologyType(TTechnologyTypeaTechnologyType)

Parameters

TTechnologyType aTechnologyType

SetVersion(TVersion)

IMPORT_C voidSetVersion(TVersionaVersion)

Parameters

TVersion aVersion

TechnologyType()

IMPORT_C TTechnologyTypeTechnologyType()const

Version()

IMPORT_C TVersionVersion()const

Member Enumerations Documentation

Enum _TCapabilities

Module Capabilities

Enumerators

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

Enumerators

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

Enumerators

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

Member Type Definitions Documentation

Typedef TCapabilities

typedef TUint32 TCapabilities

Position module capabilities

Typedef TDeviceLocation

typedef TUint32 TDeviceLocation

Device locations

Typedef TTechnologyType

typedef TUint32 TTechnologyType

Technology types

Member Data Documentation

TCapabilities iCapabilities

TCapabilities iCapabilities[protected]

The capabilities of this module

TDeviceLocation iDeviceLocation

TDeviceLocation iDeviceLocation[protected]

The location of the device associated with this module

TBool iIsAvailable

TBool iIsAvailable[protected]

Whether or not the module is available

TPositionModuleId iModuleId

TPositionModuleId iModuleId[protected]

The module ID

TBuf< KPositionMaxModuleName > iModuleName

TBuf< KPositionMaxModuleName >iModuleName[protected]

The module name

TPositionQuality iPosQuality

TPositionQuality iPosQuality[protected]

The position quality

TUint8 iReserved

TUint8 iReserved[private]

Unused variable for future expansion.

TFixedArray< TUint32, EPositionLastFamily > iSupportedClassTypes

TFixedArray< TUint32, EPositionLastFamily >iSupportedClassTypes[protected]

The array of supported classes for the different class types

TTechnologyType iTechnologyType

TTechnologyType iTechnologyType[protected]

The technology type

TVersion iVersion

TVersion iVersion[protected]

The version of this module

© Nokia 2010.