SFBPosDet

Wrapper Class for the IPosDet interface.

#include <SFBPosDet.h.hpp>

class SFBPosDet : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBPosDet)

Inheritance diagram

Version

BREW 2.0	BREW 2.1	BREW 3.1	BREW 4.0
O	O	O	O

Reference

BREW API IPosDet

Member

Public Functions
`SFCError`	ExtractPositionInfo( `AEEGPSInfo` gps , `AEEPositionInfoEx` position ) Given the position in AEEGPSInfo, this function generates the position information in the format specified by AEEPositionInfoEx.
`SFCError`	GetGPSConfig( `AEEGPSConfig*` config ) Get the current GPS configuration of the GPS engine.
`SFCError`	GetGPSInfo( `AEEGPSReq` request , `AEEGPSAccuracy` accuracy , `AEEGPSInfo*` info , `SFXCallbackPtr` callback ) Return information for GPS based position location.
`SFCError`	GetOrientation( `AEEOrientationReq` orientation , `VoidPtr` info , `SFXCallbackPtr` callback ) Return device's orientation in the horizontal plane.
`SFCError`	GetOrientation( `AEEOrientationReq` orientation , `SFXBufferPtr` info , `SFXCallbackPtr` callback ) Return device's orientation in the horizontal plane.
`SFCError`	GetSectorInfo( `AEESectorInfo*` info ) Return information for sector based position location. It returns information about the SystemID, NetworkID, BaseStationID, BaseStationClass and best Pilot.
static `SFBPosDetSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBPosDet instance.
static `SFBPosDetSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBPosDet instance.
`SFCError`	SetGPSConfig( `AEEGPSConfig*` config ) Set the GPS configuration to be used by the GPS engine.
static `Float64`	WGS84ToDegrees( `SInt32` latlon ) Convert the longitude and latitude from WGS84 spheroid coordinate into degrees of decimalization.
`SFCError`	QueryInterface( `AEECLSID` clsid , `VoidHandle` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFCError`	QueryInterface( `AEECLSID` clsid , `SFBBaseSmpPtr` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFBBaseSmp`	QueryInterface( `AEECLSID` clsid ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`Void`	Self( `AEECLSID` clsidReq , `SFBQuerySmpPtr` clone , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.
`SFBQuerySmp`	Self( `AEECLSID` clsidReq , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.

Protected Functions
static `SFBBaseSmp`	FactoryByCreate( `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface.
static `SFBBaseSmp`	FactoryByQuery( `SFBQuerySmpConstRef` query , `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface using the SFBQuery instance.

SFBPosDet::ExtractPositionInfo

Given the position in AEEGPSInfo, this function generates the position information in the format specified by AEEPositionInfoEx.

[ public ]
SFCError ExtractPositionInfo(
    AEEGPSInfo* gps               // pointer to AEEGPSInfo data
    AEEPositionInfoEx* position   // output buffer for position information
);

Return value

If succeeds: SFERR_NO_ERROR
If invalid argument: SFERR_INVALID_PARAM
If failed: SFERR_FAILED
Not supported: SFERR_UNSUPPORTED
Does not have the privilege level (PL_POS_LOCATION) : EPRIVLEVEL

Version

This function is available in BREW 3.1.

Reference

BREW API IPOSDET_ExtractPositionInfo | AEEGPSInfo

SFBPosDet::GetGPSConfig

Get the current GPS configuration of the GPS engine.

[ public ]
SFCError GetGPSConfig(
    AEEGPSConfig* config   // pointer to GPS configuration. See AEEGPSConfig for details
);

Reference

BREW API IPOSDET_GetGPSConfig | AEEGPSConfig | SFBPosDet::SetGPSConfig

SFBPosDet::GetGPSInfo

Return information for GPS based position location.

[ public ]
SFCError GetGPSInfo(
    AEEGPSReq request         
    AEEGPSAccuracy accuracy   
    AEEGPSInfo* info          
    SFXCallbackPtr callback   
);

Argument

request: Request type: AEEGPS_GETINFO_LOCATION AEEGPS_GETINFO_VELOCITY AEEGPS_GETINFO_ALTITUDE . The flags (excluding AEEGPS_GETINFO_NONE) can be combined to get more than one type of information.
accuracy: Desired level of accuracy for this request.
info: On input, this must be a valid ptr to the AEEGPSInfo structure. On callback, the members of this struct contain the position location information. The caller is notifified asynchronously using AEECallback when a response is ready. For this reason, the caller must ensure that this structure remains valid until the callback specified by pcb is called.
callback: Callback function which gets called on completion of position determination.

Reference

BREW API IPOSDET_GetGPSInfo | AEEGPSInfo

SFBPosDet::GetOrientation

Return device's orientation in the horizontal plane.

[ public ]
SFCError GetOrientation(
    AEEOrientationReq orientation   
    VoidPtr info                    
    SFXCallbackPtr callback         
);

[ public ]
SFCError GetOrientation(
    AEEOrientationReq orientation   
    SFXBufferPtr info               // if null, do nothing and return SFERR_INVALID_PARAM
    SFXCallbackPtr callback         
);

Argument

orientation: The requested information.
info: On input, this must be a valid ptr to the valid memory with the first two bytes indicating the space available in bytes. The space should be a minimum of that required to place the response corresponding the request. On callback, the members of this struct contain Orientation information corresponding to the request. The caller must ensure that this memory is valid until the callback specified by pcb gets called.
callback: Callback function which gets called on completion of the request.

Version

Supported in BREW 2.1 or later.

Reference

BREW API IPOSDET_GetOrientation

SFBPosDet::GetSectorInfo

Return information for sector based position location. It returns information about the SystemID, NetworkID, BaseStationID, BaseStationClass and best Pilot.

[ public ]
SFCError GetSectorInfo(
    AEESectorInfo* info   // pointer to the AEESectorInfo structure
);

Reference

BREW API IPOSDET_GetSectorInfo | AEESectorInfo

SFBPosDet::NewInstance

Create a new SFBPosDet instance.

[ public, static ]
SFBPosDetSmp NewInstance(
    SFCErrorPtr exception = null   // Error
);

[ public, static ]
SFBPosDetSmp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);

SFBPosDet::SetGPSConfig

Set the GPS configuration to be used by the GPS engine.

[ public ]
SFCError SetGPSConfig(
    AEEGPSConfig* config   // pointer to GPS configuration. See AEEGPSConfig for details
);

Reference

BREW API IPOSDET_SetGPSConfig | AEEGPSConfig | SFBPosDet::GetGPSConfig

SFBPosDet::WGS84ToDegrees

Convert the longitude and latitude from WGS84 spheroid coordinate into degrees of decimalization.

[ public, static ]
Float64 WGS84ToDegrees(
    SInt32 latlon   // longitude or latitude in WGS84 spheroid coordinate
);

Return value

Longitude or latitude in degrees of decimalization

Description

This function is used for the converting of longitude or latitude which gotten by SFBPosDet::GetGPSInfo().

Version

Supported in BREW 2.1 or later.

Reference

BREW API WGS84_TO_DEGREES