S60 3rd Edition API Reference: TPositionModuleInfo Class Reference

TPositionModuleInfo Class Reference

API published in: S60 2nd Ed FP 2

Link against: lbs.lib

Capability Information

Required Capabilities

Location

#include <lbscommon.h>

Inherits TPositionModuleInfoBase.

Detailed Description

The standard class for storing information about positioning modules.

Public Types

typedef TUint32 TTechnologyType
 Defines the various positioning technology types that are used by positioning modules to obtain location information.
typedef TUint32 TDeviceLocation
 Defines the way the positioning technology hardware is integrated to the system.
typedef TUint32 TCapabilities
 Defines the different location attributes that a positioning technology can provide the client.
enum  _TTechnologyType { ETechnologyUnknown = 0, ETechnologyTerminal = 0x01, ETechnologyNetwork = 0x02, ETechnologyAssisted = 0x04 }
 Technology types. More...
enum  _TDeviceLocation { EDeviceUnknown = 0, EDeviceInternal = 0x01, EDeviceExternal = 0x02 }
 Device locations. More...
enum  _TCapabilities {
  ECapabilityNone = 0, ECapabilityHorizontal = 0x0001, ECapabilityVertical = 0x0002, ECapabilitySpeed = 0x0004,
  ECapabilityDirection = 0x0008, ECapabilitySatellite = 0x0010, ECapabilityCompass = 0x0020, ECapabilityNmea = 0x0040,
  ECapabilityAddress = 0x0080, ECapabilityBuilding = 0x0100, ECapabilityMedia = 0x0200
}
 Position module capabilities. More...

Public Member Functions

IMPORT_C TPositionModuleInfo ()
 Default constructor for TPositionModuleInfo.
IMPORT_C TPositionModuleId ModuleId () const
 Get the unique identifier that specifies the positioning module.
IMPORT_C TBool IsAvailable () const
 Check if the positioning module is available for use.
IMPORT_C void GetModuleName (TDes &aModuleName) const
 Obtain the positioning module name.
IMPORT_C void GetPositionQuality (TPositionQuality &aPosQuality) const
 Get the quality of the positioning information that a positioning module is able to provide.
IMPORT_C TTechnologyType TechnologyType () const
 Get the primary technologies used to obtain position information.
IMPORT_C TDeviceLocation DeviceLocation () const
 Get information on whether the positioning hardware used by the positioning module is an integrated device or an external device.
IMPORT_C TCapabilities Capabilities () const
 Get information about the range of position information this positioning module is capable of returning.
IMPORT_C TUint32 ClassesSupported (TPositionClassFamily aClassType) const
 Get the classes supported by this positioning module.
IMPORT_C TVersion Version () const
 The version of the positioning module.
IMPORT_C void SetModuleId (TPositionModuleId aModuleId)
 This method is not intended for the client's usage.
IMPORT_C void SetIsAvailable (TBool aIsAvailable)
 This method is not intended for the client's usage.
IMPORT_C void SetModuleName (const TDesC &aModuleName)
 This method is not intended for the client's usage.
IMPORT_C void SetPositionQuality (const TPositionQuality &aPosQuality)
 This method is not intended for the client's usage.
IMPORT_C void SetTechnologyType (TTechnologyType aTechnologyType)
 This method is not intended for the client's usage.
IMPORT_C void SetDeviceLocation (TDeviceLocation aDeviceLocation)
 This method is not intended for the client's usage.
IMPORT_C void SetCapabilities (TCapabilities aDeviceCapabilities)
 This method is not intended for the client's usage.
IMPORT_C void SetClassesSupported (TPositionClassFamily aClassType, TUint32 aSupportedClasses)
 This method is not intended for the client's usage.
IMPORT_C void SetVersion (TVersion aVersion)
 This method is not intended for the client's usage.

Protected Attributes

TPositionModuleId iModuleId
 The module ID.
TBool iIsAvailable
 Whether or not the module is available.
TBuf< KPositionMaxModuleName > iModuleName
 The module name.
TPositionQuality iPosQuality
 The position quality.
TTechnologyType iTechnologyType
 The technology type.
TDeviceLocation iDeviceLocation
 The location of the device associated with this module.
TCapabilities iCapabilities
 The capabilities of this module.
TFixedArray< TUint32, EPositionLastFamily > iSupportedClassTypes
 The array of supported classes for the different class types.
TVersion iVersion
 The version of this module.

Member Typedef Documentation

typedef TUint32 TPositionModuleInfo::TCapabilities
 

Defines the different location attributes that a positioning technology can provide the client.

The enumerated values are specified in _TCapabilities.

typedef TUint32 TPositionModuleInfo::TDeviceLocation
 

Defines the way the positioning technology hardware is integrated to the system.

The enumerated values are specified in _TDeviceLocation.

typedef TUint32 TPositionModuleInfo::TTechnologyType
 

Defines the various positioning technology types that are used by positioning modules to obtain location information.

The enumerated values are specified in _TTechnologyType.

Member Enumeration Documentation

enum TPositionModuleInfo::_TCapabilities
 

Position module capabilities.

Enumerator:
ECapabilityNone  An unassigned value.
ECapabilityHorizontal  Positioning modules with this capability support the TPositionInfo class and are able to provide latitude and longitude related information.
ECapabilityVertical  Positioning modules with this capability support the TPositionInfo class and are able to provide altitude related information apart from latitude and longitude.
ECapabilitySpeed  Positioning modules with this capability support the TPositionCourseInfo class and are able to provide information related to the current horizontal speed.
ECapabilityDirection  Positioning modules with this capability support the TPositionCourseInfo class and are able to provide heading and course related information.
ECapabilitySatellite  Positioning modules with this capability support the TPositionSatelliteInfo class.

Such a module is able to return at least some satellite data

ECapabilityCompass  Positioning modules with this capability are able to return information related to a magnetic compass.
ECapabilityNmea  Positioning modules with this capability are able to return location information using NMEA formatted text strings.
ECapabilityAddress  Positioning modules with this capability are able to return information related to the postal address of the current location.
ECapabilityBuilding  Positioning modules with this capability are able to return the current position in terms of where it is within a building.
ECapabilityMedia  Positioning modules with this capability are able to provide a link to further information about the location.

The standard mechanism is via a URL

enum TPositionModuleInfo::_TDeviceLocation
 

Device locations.

Enumerator:
EDeviceUnknown  Indicates that the positioning module is unaware of the hardware used to supply positioning information.
EDeviceInternal  indicates that the positioning hardware is integral to the terminal.
EDeviceExternal  indicates that the positioning hardware is separate from the terminal
enum TPositionModuleInfo::_TTechnologyType
 

Technology types.

Enumerator:
ETechnologyUnknown  indicates that the positioning module is unaware of the technology used to obtain position information
ETechnologyTerminal  indicates that the primary positioning technology is handset based.
ETechnologyNetwork  indicates that the primary positioning technology is network based.
ETechnologyAssisted  indicates that the primary positioning mechanism receives assistance in some form.

Generally to obtain a quicker or more accurate fix.

Constructor & Destructor Documentation

IMPORT_C TPositionModuleInfo::TPositionModuleInfo (   ) 
 

Default constructor for TPositionModuleInfo.

Member Function Documentation

IMPORT_C TCapabilities TPositionModuleInfo::Capabilities (   )  const
 

Get information about the range of position information this positioning module is capable of returning.

Returns:
The capabilities of this module
IMPORT_C TUint32 TPositionModuleInfo::ClassesSupported ( TPositionClassFamily  aClassType  )  const
 

Get the classes supported by this positioning module.

Parameters:
aClassType indicates the position class family to query the support. For example, using EPositionInfoFamily returns a bit mask of values from the enumeration TPositionInfoClassType. The returned bitmask indicates the position information classes that are supported by the positioning module
See also:
TPositionClassFamily for different family types.
Returns:
bitmask of the classes supported for the specified family type.
Panic:
"Lbs Client Fault" 8 if the aClassType parameter does not represent a known family value.
IMPORT_C TDeviceLocation TPositionModuleInfo::DeviceLocation (   )  const
 

Get information on whether the positioning hardware used by the positioning module is an integrated device or an external device.

Returns:
The location of the positioning device associated with this module
IMPORT_C void TPositionModuleInfo::GetModuleName ( TDes &  aModuleName  )  const
 

Obtain the positioning module name.

Parameters:
[out] aModuleName The descriptor where the module's name will be placed
IMPORT_C void TPositionModuleInfo::GetPositionQuality ( TPositionQuality &  aPosQuality  )  const
 

Get the quality of the positioning information that a positioning module is able to provide.

Parameters:
[out] aPosQuality The quality of the position
IMPORT_C TBool TPositionModuleInfo::IsAvailable (   )  const
 

Check if the positioning module is available for use.

Returns:
Whether or not this module is available

ETrue if the module is available

EFalse if the module is not available

IMPORT_C TPositionModuleId TPositionModuleInfo::ModuleId (   )  const
 

Get the unique identifier that specifies the positioning module.

Returns:
The module ID
IMPORT_C void TPositionModuleInfo::SetCapabilities ( TCapabilities  aDeviceCapabilities  ) 
 

This method is not intended for the client's usage.

This method is used by Location framework to set information about the different positioning related fields that this positioning module is capable of returning.

Parameters:
aDeviceCapabilities Bitfield of the capabilities of this module to set
IMPORT_C void TPositionModuleInfo::SetClassesSupported ( TPositionClassFamily  aClassType,
TUint32  aSupportedClasses
) 
 

This method is not intended for the client's usage.

This method is used by Location framework to set the different positioning information classes that this positioning module supports.

Parameters:
aClassType indicates the position class family.
aSupportedClasses a bit mask value of the supported classes for the specified class family type.
See also:
TPositionClassFamily for different family types.
IMPORT_C void TPositionModuleInfo::SetDeviceLocation ( TDeviceLocation  aDeviceLocation  ) 
 

This method is not intended for the client's usage.

This method is used by Location framework to set information on whether the positioning hardware used by the positioning module is an integrated device or an external device.

Parameters:
aDeviceLocation The positioning device location to set
IMPORT_C void TPositionModuleInfo::SetIsAvailable ( TBool  aIsAvailable  ) 
 

This method is not intended for the client's usage.

This method is used by Location framework to set whether this positioning module is available for position determination or not.

Parameters:
aIsAvailable Whether or not the module is available for use
IMPORT_C void TPositionModuleInfo::SetModuleId ( TPositionModuleId  aModuleId  ) 
 

This method is not intended for the client's usage.

This method is used by Location framework to set the module ID for the positioning module

Parameters:
aModuleId The module ID to set
IMPORT_C void TPositionModuleInfo::SetModuleName ( const TDesC &  aModuleName  ) 
 

This method is not intended for the client's usage.

This method is used by Location framework to set the name of the positioning module.

Parameters:
[in] aModuleName The module name to set
IMPORT_C void TPositionModuleInfo::SetPositionQuality ( const TPositionQuality &  aPosQuality  ) 
 

This method is not intended for the client's usage.

This method is used by Location framework to set the quality of the positioning information that the positioning module can provide.

Parameters:
[in] aPosQuality The position quality to set
IMPORT_C void TPositionModuleInfo::SetTechnologyType ( TTechnologyType  aTechnologyType  ) 
 

This method is not intended for the client's usage.

This method is used by Location framework to set the primary technologies used to obtain position information. This is a bit mask consisting of the enumerated values of _TTechnologyType.

Parameters:
aTechnologyType The technology type to set
IMPORT_C void TPositionModuleInfo::SetVersion ( TVersion  aVersion  ) 
 

This method is not intended for the client's usage.

This method is used by Location framework to set the version of this positioning module.

Parameters:
aVersion The version to set
IMPORT_C TTechnologyType TPositionModuleInfo::TechnologyType (   )  const
 

Get the primary technologies used to obtain position information.

This is a bit mask consisting of the enumerated values of _TTechnologyType.

Returns:
The technology type
IMPORT_C TVersion TPositionModuleInfo::Version (   )  const
 

The version of the positioning module.

Returns:
The version of the module

Field Documentation

TCapabilities TPositionModuleInfo::iCapabilities [protected]
 

The capabilities of this module.

TDeviceLocation TPositionModuleInfo::iDeviceLocation [protected]
 

The location of the device associated with this module.

TBool TPositionModuleInfo::iIsAvailable [protected]
 

Whether or not the module is available.

TPositionModuleId TPositionModuleInfo::iModuleId [protected]
 

The module ID.

TBuf<KPositionMaxModuleName> TPositionModuleInfo::iModuleName [protected]
 

The module name.

TPositionQuality TPositionModuleInfo::iPosQuality [protected]
 

The position quality.

TFixedArray<TUint32, EPositionLastFamily> TPositionModuleInfo::iSupportedClassTypes [protected]
 

The array of supported classes for the different class types.

TTechnologyType TPositionModuleInfo::iTechnologyType [protected]
 

The technology type.

TVersion TPositionModuleInfo::iVersion [protected]
 

The version of this module.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top