Edit

GNSS_FIXSESSION_PARAM structure (gnssdriver.h)

  • Article

This structure defines the parameters used by the GNSS adapter to start a fix session.

Syntax

typedef struct {
  ULONG               Size;
  ULONG               Version;
  ULONG               FixSessionID;
  GNSS_FIXSESSIONTYPE SessionType;
  ULONG               HorizontalAccuracy;
  ULONG               HorizontalConfidence;
  ULONG               Reserved[9];
  ULONG               FixLevelOfDetails;
  union {
    GNSS_SINGLESHOT_PARAM         SingleShotParam;
    GNSS_DISTANCETRACKING_PARAM   DistanceParam;
    GNSS_CONTINUOUSTRACKING_PARAM ContinuousParam;
    GNSS_LKGFIX_PARAM             LkgFixParam;
    BYTE                          UnusedParam[268];
  };
  BYTE                Unused[256];
} GNSS_FIXSESSION_PARAM, *PGNSS_FIXSESSION_PARAM;

Members

Size

Structure size.

Version

Version number.

FixSessionID

This is a unique identifier for a particular fix session.

The GNSS adapter generates this number in a monotonically increasing order whenever a new fix session is requested. The number wraps around to zero. Given the lifetime of an active session and the number of possible parallel sessions even with multi-session support, the wrap-around is acceptable in this use case.

The GNSS driver must associate all fix related data to the original fix session by using the FixSessionID field. If the GNSS driver does not support multiple fix sessions, it may use the session ID of the last fix session request.

SessionType

Identifies the type or recurrence type of this fix session.

HorizontalAccuracy

The horizontal accuracy of the fix requested is only advisory information for the GNSS driver that can be used in an implementation-specific manner for making appropriate tradeoffs internally to satisfy the request.

A value of 0 indicates no particular accuracy is mandated by the GNSS adapter.

HorizontalConfidence

The horizontal confidence is the circular confidence requested for this fix.

The platform expects fixes with a 95% confidence. The GNSS driver should honor this confidence value when it returns the fix and accuracy from the GNSS engine.

Reserved[9]

Padding buffer reserved for future use.

FixLevelOfDetails

Indicates the level of detail needed when the GNSS driver returns the fix information.

The GNSS driver may choose to override this input.

This flag is OR-ed with the bit-values defined in GNSS_FIXDETAIL_* mask.

SingleShotParam

The GNSS_SINGLESHOT_PARAM structure defines the parameters for a single-shot fix session.

DistanceParam

The GNSS_DISTANCETRACKING_PARAM structure defines the parameters for a distance-based tracking fix session.

ContinuousParam

The GNSS_CONTINUOUSTRACKING_PARAM structure defines the parameters for a continuous tracking fix session.

LkgFixParam

The GNSS_LKGFIX_PARAM structure is not used currently by the system.

UnusedParam[268]

Padding buffer reserved for future use.

Unused[256]

Padding buffer reserved for future use.

Remarks

The fix session parameters are different for different types of sessions. This structure contains a common set of parameters applicable for all fix sessions, followed by an overloaded structure (union) for each fix session type. The GNSS driver must use the appropriate structure from the union depending on the session type.

Requirements

Requirement Value
Header gnssdriver.h (include Gnssdriver.h)