
SYMBIAN OS V9.3

Location: LbsCommon.h
Link against: lbsselflocate.lib

Class `TPositionModuleInfo`

class TPositionModuleInfo : public TPositionModuleInfoBase;

Description

The standard class for storing information on position modules

Derivation

TPositionClassTypeBase - The base class for classes used to store position information

TPositionModuleInfoBase - The base class for classes storing information on position modules

TPositionModuleInfo - The standard class for storing information on position modules

Members

Defined in TPositionModuleInfo:
Capabilities(), ClassesSupported(), DeviceLocation(), ECapabilityAddress, ECapabilityBuilding, ECapabilityCompass, ECapabilityDirection, ECapabilityHorizontal, ECapabilityMedia, ECapabilityNmea, ECapabilityNone, ECapabilitySatellite, ECapabilitySpeed, ECapabilityVertical, EDeviceExternal, EDeviceInternal, EDeviceUnknown, ETechnologyAssisted, ETechnologyNetwork, ETechnologyTerminal, ETechnologyUnknown, GetModuleName(), GetPositionQuality(), IsAvailable(), ModuleId(), SetCapabilities(), SetClassesSupported(), SetDeviceLocation(), SetIsAvailable(), SetModuleId(), SetModuleName(), SetPositionQuality(), SetTechnologyType(), SetVersion(), TCapabilities, TDeviceLocation, TPositionModuleInfo(), TTechnologyType, TechnologyType(), Version(), _TCapabilities, _TDeviceLocation, _TTechnologyType, iCapabilities, iDeviceLocation, iIsAvailable, iModuleId, iModuleName, iPosQuality, iSupportedClassTypes, iTechnologyType, iVersion

Inherited from TPositionClassTypeBase:
PositionClassSize(), PositionClassType(), iPosClassSize, iPosClassType

Construction and destruction

`TPositionModuleInfo()`

IMPORT_C TPositionModuleInfo();

Description

Default constructor for TPositionModuleInfo

Member functions

`ModuleId()`

IMPORT_C TPositionModuleId ModuleId() const;

Description

Module Id

Return value

TPositionModuleId

The module ID

`IsAvailable()`

IMPORT_C TBool IsAvailable() const;

Description

Returns Availablity

Return value

TBool

Whether or not this module is available

`GetModuleName()`

IMPORT_C void GetModuleName(TDes &aModuleName) const;

Description

Gets Module Name

Parameters


                              TDes &aModuleName

The descriptor where the module's name will be placed

`GetPositionQuality()`

IMPORT_C void GetPositionQuality(TPositionQuality &aPosQuality) const;

Description

Gets Position Quality

Parameters


                              TPositionQuality &aPosQuality

The quality of the position

`TechnologyType()`

IMPORT_C TTechnologyType TechnologyType() const;

Description

Technology Type

Return value

TTechnologyType

The technology type

`DeviceLocation()`

IMPORT_C TDeviceLocation DeviceLocation() const;

Description

Device Location

Return value

TDeviceLocation

The location of the positioning device associated with this module

`Capabilities()`

IMPORT_C TCapabilities Capabilities() const;

Description

Capabilities

Return value

TCapabilities

The capabilities of this module

`ClassesSupported()`

IMPORT_C TUint32 ClassesSupported(TPositionClassFamily aClassType) const;

Description

Classes Supported

Parameters


                              TPositionClassFamily aClassType

Classes Supported

Return value

TUint32

The classes supported

`Version()`

IMPORT_C TVersion Version() const;

Description

Module Version

Return value

TVersion

The version of the module

`SetModuleId()`

IMPORT_C void SetModuleId(TPositionModuleId aModuleId);

Description

Sets module Id

Parameters


                              TPositionModuleId aModuleId

The module ID to set

`SetIsAvailable()`

IMPORT_C void SetIsAvailable(TBool aIsAvailable);

Description

Sets module availablity

Parameters


                              TBool aIsAvailable

Whether or not the module is available for use

`SetModuleName()`

IMPORT_C void SetModuleName(const TDesC &aModuleName);

Description

Sets module name

Parameters

const TDesC &aModuleName

The module name to set

`SetPositionQuality()`

IMPORT_C void SetPositionQuality(const TPositionQuality &aPosQuality);

Description

Sets position quality

Parameters

const TPositionQuality &aPosQuality

The position quality to set

`SetTechnologyType()`

IMPORT_C void SetTechnologyType(TTechnologyType aTechnologyType);

Description

Sets technology type

Parameters


                              TTechnologyType aTechnologyType

The technology type to set

`SetDeviceLocation()`

IMPORT_C void SetDeviceLocation(TDeviceLocation aDeviceLocation);

Description

Sets device location

Parameters


                              TDeviceLocation aDeviceLocation

The positioning device location to set

`SetCapabilities()`

IMPORT_C void SetCapabilities(TCapabilities aDeviceCapabilities);

Description

Sets capabilities

Parameters


                              TCapabilities aDeviceCapabilities

Bitfield of the capabilities of this module to set

`SetClassesSupported()`

IMPORT_C void SetClassesSupported(TPositionClassFamily aClassType, TUint32 aSupportedClasses);

Description

Sets supported classes

Parameters

`TPositionClassFamily aClassType`	The class type
`TUint32 aSupportedClasses`	The supported classes

`SetVersion()`

IMPORT_C void SetVersion(TVersion aVersion);

Description

Sets Version

Parameters


                              TVersion aVersion

The version to set

Member enumerations

Enum `_TTechnologyType`

_TTechnologyType

Description

Technology Type

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

Enum `_TDeviceLocation`

_TDeviceLocation

Description

Device location

`EDeviceUnknown`	The positioning module is unaware of the hardware used to supply positioning information
`EDeviceInternal`	The positioning hardware is integral to the terminal
`EDeviceExternal`	The positioning hardware is separate from the terminal

Enum `_TCapabilities`

_TCapabilities

Description

Module Capabilities

`ECapabilityNone`	No Capabilities
`ECapabilityHorizontal`	Positioning modules with this capability will support the `TPositionInfo` class and are able to provide latitude and longitude related information
`ECapabilityVertical`	Positioning modules with this capability will support the `TPositionInfo` class and are able to provide height related information
`ECapabilitySpeed`	Positioning modules with this capability will support the `TPositionCourseInfo` class and are able to provide information related to the current horizontal speed
`ECapabilityDirection`	Positioning modules with this capability will support the `TPositionCourseInfo` class and are able to provide heading related information
`ECapabilitySatellite`	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`	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`	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`	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`	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`	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

Member type definitions

Typedef `TTechnologyType`

typedef TUint32 TPositionModuleInfo::TTechnologyType;

Description

Technology types

Typedef `TDeviceLocation`

typedef TUint32 TPositionModuleInfo::TDeviceLocation;

Description

Device locations

Typedef `TCapabilities`

typedef TUint32 TPositionModuleInfo::TCapabilities;

Description

Position module capabilities

Member data

`iModuleId`

protected: TPositionModuleId iModuleId;

Description

The module ID

`iIsAvailable`

protected: TBool iIsAvailable;

Description

Whether or not the module is available

`iModuleName`

protected: TBuf< KPositionMaxModuleName > iModuleName;

Description

The module name

`iPosQuality`

protected: TPositionQuality iPosQuality;

Description

The position quality

`iTechnologyType`

protected: TTechnologyType iTechnologyType;

Description

The technology type

`iDeviceLocation`

protected: TDeviceLocation iDeviceLocation;

Description

The location of the device associated with this module

`iCapabilities`

protected: TCapabilities iCapabilities;

Description

The capabilities of this module

`iSupportedClassTypes`

protected: TFixedArray< TUint32, EPositionLastFamily > iSupportedClassTypes;

Description

The array of supported classes for the different class types

`iVersion`

protected: TVersion iVersion;

Description

The version of this module

Class TPositionModuleInfo

Description

Derivation

Members

Construction and destruction

TPositionModuleInfo()

Description

Member functions

ModuleId()

Description

Return value

IsAvailable()

Description

Return value

GetModuleName()

Description

Parameters

GetPositionQuality()

Description

Parameters

TechnologyType()

Description

Return value

DeviceLocation()

Description

Return value

Capabilities()

Description

Return value

ClassesSupported()

Description

Parameters

Return value

Version()

Description

Return value

SetModuleId()

Description

Parameters

SetIsAvailable()

Description

Parameters

SetModuleName()

Description

Parameters

SetPositionQuality()

Description

Parameters

SetTechnologyType()

Description

Parameters

SetDeviceLocation()

Description

Parameters

SetCapabilities()

Description

Parameters

SetClassesSupported()

Description

Parameters

SetVersion()

Description

Parameters

Member enumerations

Enum _TTechnologyType

Description

Enum _TDeviceLocation

Description

Enum _TCapabilities

Description

Member type definitions

Typedef TTechnologyType

Description

Typedef TDeviceLocation

Description

Typedef TCapabilities

Description

Member data

iModuleId

Description

Class `TPositionModuleInfo`

`TPositionModuleInfo()`

`ModuleId()`

`IsAvailable()`

`GetModuleName()`

`GetPositionQuality()`

`TechnologyType()`

`DeviceLocation()`

`Capabilities()`

`ClassesSupported()`

`Version()`

`SetModuleId()`

`SetIsAvailable()`

`SetModuleName()`

`SetPositionQuality()`

`SetTechnologyType()`

`SetDeviceLocation()`

`SetCapabilities()`

`SetClassesSupported()`

`SetVersion()`

Enum `_TTechnologyType`

Enum `_TDeviceLocation`

Enum `_TCapabilities`

Typedef `TTechnologyType`

Typedef `TDeviceLocation`

Typedef `TCapabilities`

`iModuleId`

`iIsAvailable`

`iModuleName`

`iPosQuality`

`iTechnologyType`

`iDeviceLocation`

`iCapabilities`

`iSupportedClassTypes`

`iVersion`