This document lists the main classes of the Location Acquisition API with links to reference documentation.
This document provides a list of the main classes and types that are part of the Location Acquisition API. Each section gives a brief description of the purpose of the classes. The links can be followed to:
This section describes the most important classes of the Location Acquisition API.
Client/server interaction classes
RPositionServer is the class used to make a connection to the location server.
RPositioner is the class used to create a sub-session with the location server for the purpose of obtaining the current position.
See also
Location Acquisition API Overview
How to Get Location Information
Position data classes
TCoordinate is the class that holds the basic coordinates of a location (latitude, longitude and altitude).
TLocality is the class that adds an error estimate for the horizontal and vertical accuracy of a TCoordinate.
TPosition is the standard data structure for retrieving location data. It adds a timestamp to the inherited TLocality information.
See also
Position Data and Info Classes
Data retrieval classes
TPositionInfo is the standard class for getting a TPosition location fix from the location server.
See also
Position Data and Info Classes
How to Get Location Information
Extended data retrieval classes
TCourse is the class used to hold information about the current speed and direction of the device.
TPositionCourseInfo is the class for getting TCourse data from the location server.
TSatelliteData is the class that holds satellite data.
TPositionSatelliteInfo is the class for getting TSatelliteData from the location server.
HPositionGenericInfo is the class for passing extended position data between a client and the Location Server.
See also
Position Data and Info Classes
Module information
TPositionModuleInfo is the class that holds information on position modules. This information includes the capabilities of the module, such as whether it can supply altitude or satellite data and the quality of position described by a TPositionQuality object.
TPositionQuality is the class that describes the quality of position that a positioning module can deliver.
See also
Module updates, status and events
TPositionModuleStatus is the class that describes a positioning module's status, such as whether it is ready or disabled.
TPositionModuleStatusEvent is the class used to indicate that a module status change has occurred.
TPositionUpdateOptions is the class used by a client to set position update options such as a request timeout and whether partial updates are accepted.
See also
How to Get Module Status Changes
Privacy requester classes
CRequestor defines a privacy requester (such as a service or contact) that is requesting location information.
RRequestorStack defines a stack of CRequestors and is used when requester acts on behalf of another to request location information.
See also
To use the Location Acquisition API, client applications do the following:
Include the appropriate header files defined in table 1 below.
| Header file | Contents |
|---|---|
| Main client/server classes |
| Enumerated types used in the API |
| API constants, positioning module status and quality classes |
| Positioning module criteria classes |
| API error and panic codes |
| Field ids used by extended data class |
| |
| Values used for client/server IPC |
| Values used for client/server IPC |
| Position data classes |
| Position info classes |
| Privacy requester classes. |
| Classes for satellite data and info. |
Table 1. Location Acquisition API header files.
link against the library lbs.dll (import library is lbs.lib).