taf_locGnss_interface.h

Go to the documentation of this file.

/*
 * ====================== WARNING ======================
 *
 * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
 * DO NOT MODIFY IN ANY WAY.
 *
 * ====================== WARNING ======================
 */

#ifndef TAF_LOCGNSS_INTERFACE_H_INCLUDE_GUARD
#define TAF_LOCGNSS_INTERFACE_H_INCLUDE_GUARD


#include "legato.h"

// Internal includes for this interface
#include "taf_locGnss_common.h"
//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*taf_locGnss_DisconnectHandler_t)(void *);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_locGnss_ConnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_TryConnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_FULL_API void taf_locGnss_SetServerDisconnectHandler
(
    taf_locGnss_DisconnectHandler_t disconnectHandler,
    void *contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_FULL_API void taf_locGnss_SetNonExitServerDisconnectHandler
(
    taf_locGnss_DisconnectHandler_t disconnectHandler,
    void *contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_locGnss_DisconnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_locGnss_PositionHandlerRef_t taf_locGnss_AddPositionHandler
(
    taf_locGnss_PositionHandlerFunc_t handlerPtr,
    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_locGnss_RemovePositionHandler
(
    taf_locGnss_PositionHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_locGnss_CapabilityChangeHandlerRef_t taf_locGnss_AddCapabilityChangeHandler
(
    taf_locGnss_CapabilityChangeHandlerFunc_t handlerPtr,
    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_locGnss_RemoveCapabilityChangeHandler
(
    taf_locGnss_CapabilityChangeHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_locGnss_SampleRef_t taf_locGnss_GetLastSampleRef
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetPositionState
(
    taf_locGnss_SampleRef_t positionSampleRef,
    taf_locGnss_FixState_t* statePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_locGnss_ReleaseSampleRef
(
    taf_locGnss_SampleRef_t positionSampleRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetLocation
(
    taf_locGnss_SampleRef_t positionSampleRef,
    int32_t* latitudePtr,
    int32_t* longitudePtr,
    int32_t* hAccuracyPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetDirection
(
    taf_locGnss_SampleRef_t positionSampleRef,
    uint32_t* directionPtr,
    uint32_t* directionAccuracyPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetAltitude
(
    taf_locGnss_SampleRef_t positionSampleRef,
    int32_t* altitudePtr,
    int32_t* vAccuracyPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetHorizontalSpeed
(
    taf_locGnss_SampleRef_t positionSampleRef,
    uint32_t* hspeedPtr,
    uint32_t* hspeedAccuracyPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetVerticalSpeed
(
    taf_locGnss_SampleRef_t positionSampleRef,
    int32_t* vspeedPtr,
    int32_t* vspeedAccuracyPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetGpsLeapSeconds
(
    taf_locGnss_SampleRef_t positionSampleRef,
    uint8_t* leapSecondsPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetDate
(
    taf_locGnss_SampleRef_t positionSampleRef,
    uint16_t* yearPtr,
    uint16_t* monthPtr,
    uint16_t* dayPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetTime
(
    taf_locGnss_SampleRef_t positionSampleRef,
    uint16_t* hoursPtr,
    uint16_t* minutesPtr,
    uint16_t* secondsPtr,
    uint16_t* millisecondsPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_Enable
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_Start
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_Disable
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_Stop
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_SetConstellation
(
    taf_locGnss_ConstellationBitMask_t blackListConstellationMask
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetConstellation
(
    taf_locGnss_ConstellationBitMask_t* blackListConstellationMaskPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_locGnss_NmeaHandlerRef_t taf_locGnss_AddNmeaHandler
(
    taf_locGnss_NmeaHandlerFunc_t handlerPtr,
    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_locGnss_RemoveNmeaHandler
(
    taf_locGnss_NmeaHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_locGnss_State_t taf_locGnss_GetState
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetSatellitesStatus
(
    taf_locGnss_SampleRef_t positionSampleRef,
    uint8_t* satsInViewCountPtr,
    uint8_t* satsTrackingCountPtr,
    uint8_t* satsUsedCountPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetAcquisitionRate
(
    uint32_t* ratePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetTtff
(
    uint32_t* ttffPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetSatellitesInfo
(
    taf_locGnss_SampleRef_t positionSampleRef,
    uint16_t* satIdPtr,
    size_t* satIdSizePtr,
    taf_locGnss_Constellation_t* satConstPtr,
    size_t* satConstSizePtr,
    bool* satUsedPtr,
    size_t* satUsedSizePtr,
    uint8_t* satSnrPtr,
    size_t* satSnrSizePtr,
    uint16_t* satAzimPtr,
    size_t* satAzimSizePtr,
    uint8_t* satElevPtr,
    size_t* satElevSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetTimeAccuracy
(
    taf_locGnss_SampleRef_t positionSampleRef,
    uint32_t* timeAccuracyPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetEpochTime
(
    taf_locGnss_SampleRef_t positionSampleRef,
    uint64_t* millisecondsPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_SetDopResolution
(
    taf_locGnss_Resolution_t resolution
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetDilutionOfPrecision
(
    taf_locGnss_SampleRef_t positionSampleRef,
    taf_locGnss_DopType_t dopType,
    uint16_t* dopPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetLeapSeconds
(
    uint64_t* gpsTimePtr,
    int32_t* currentLeapSecondsPtr,
    uint64_t* changeEventTimePtr,
    int32_t* nextLeapSecondsPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetGpsTime
(
    taf_locGnss_SampleRef_t positionSampleRef,
    uint32_t* gpsWeekPtr,
    uint32_t* gpsTimeOfWeekPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_SetAcquisitionRate
(
    uint32_t rate
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_ForceWarmRestart
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_ForceColdRestart
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_ForceFactoryRestart
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_ForceHotRestart
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetSupportedConstellations
(
    taf_locGnss_ConstellationBitMask_t* constellationMaskPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_SetMinElevation
(
    uint8_t minElevation
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_StartMode
(
    taf_locGnss_StartMode_t mode
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetMinElevation
(
    uint8_t* minElevationPtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_SetNmeaSentences
(
    taf_locGnss_NmeaBitMask_t nmeaMask
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetNmeaSentences
(
    taf_locGnss_NmeaBitMask_t* nmeaMaskPtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_SetDRConfig
(
    const taf_locGnss_DrParams_t * LE_NONNULL drParamsPtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetSupportedNmeaSentences
(
    taf_locGnss_NmeaBitMask_t* nmeaMaskPtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_ConfigureEngineState
(
    taf_locGnss_EngineType_t engtype,
    taf_locGnss_EngineState_t engState
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_ConfigureRobustLocation
(
    uint8_t enable,
    uint8_t enabled911
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_RobustLocationInformation
(
    uint8_t* enablePtr,
    uint8_t* enabled911Ptr,
    uint8_t* majorVersionPtr,
    uint8_t* minorVersionPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_DefaultSecondaryBandConstellations
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_RequestSecondaryBandConstellations
(
    uint32_t* constellationSbPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_ConfigureSecondaryBandConstellations
(
    uint32_t constellationSb
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetMagneticDeviation
(
    taf_locGnss_SampleRef_t positionSampleRef,
    int32_t* magneticDeviationPtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetEllipticalUncertainty
(
    taf_locGnss_SampleRef_t positionSampleRef,
    uint32_t* horUncEllipseSemiMajorPtrPtr,
    uint32_t* horUncEllipseSemiMinorPtrPtr,
    uint8_t* horConfidencePtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_SetLeverArmConfig
(
    const taf_locGnss_LeverArmParams_t * LE_NONNULL LeverArmParamsPtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_SetEngineType
(
    taf_locGnss_EngineReportsType_t EngineType
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetConformityIndex
(
    taf_locGnss_SampleRef_t positionSampleRef,
    double* indexPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetCalibrationData
(
    taf_locGnss_SampleRef_t positionSampleRef,
    uint32_t* calibPtrPtr,
    uint8_t* percentPtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetBodyFrameData
(
    taf_locGnss_SampleRef_t positionSampleRef,
    taf_locGnss_KinematicsData_t * bodyDataPtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetVRPBasedLLA
(
    taf_locGnss_SampleRef_t positionSampleRef,
    double* vrpLatitudePtrPtr,
    double* vrpLongitudePtrPtr,
    double* vrpAltitudePtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetVRPBasedVelocity
(
    taf_locGnss_SampleRef_t positionSampleRef,
    double* eastVelPtrPtr,
    double* northVelPtrPtr,
    double* upVelPtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetSvUsedInPosition
(
    taf_locGnss_SampleRef_t positionSampleRef,
    taf_locGnss_SvUsedInPosition_t * svDataPtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetSbasCorrection
(
    taf_locGnss_SampleRef_t positionSampleRef,
    uint32_t* sbasMaskPtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetPositionTechnology
(
    taf_locGnss_SampleRef_t positionSampleRef,
    uint32_t* techMaskPtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetLocationInfoValidity
(
    taf_locGnss_SampleRef_t positionSampleRef,
    uint32_t* validityMaskPtrPtr,
    uint64_t* validityExMaskPtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetLocationOutputEngParams
(
    taf_locGnss_SampleRef_t positionSampleRef,
    uint16_t* engMaskPtrPtr,
    uint16_t* engTypePtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetReliabilityInformation
(
    taf_locGnss_SampleRef_t positionSampleRef,
    uint16_t* horiReliabilityPtrPtr,
    uint16_t* vertReliabilityPtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetStdDeviationAzimuthInfo
(
    taf_locGnss_SampleRef_t positionSampleRef,
    double* azimuthPtrPtr,
    double* eastDevPtrPtr,
    double* northDevPtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetRealTimeInformation
(
    taf_locGnss_SampleRef_t positionSampleRef,
    uint64_t* realTimePtrPtr,
    uint64_t* realTimeUncPtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetMeasurementUsageInfo
(
    taf_locGnss_SampleRef_t positionSampleRef,
    taf_locGnss_GnssMeasurementInfo_t* measInfoPtrPtr,
    size_t* measInfoPtrSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetReportStatus
(
    taf_locGnss_SampleRef_t positionSampleRef,
    int32_t* reportStatusPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetAltitudeMeanSeaLevel
(
    taf_locGnss_SampleRef_t positionSampleRef,
    double* altMeanSeaLevelPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetSVIds
(
    taf_locGnss_SampleRef_t positionSampleRef,
    uint16_t* sVIdsPtrPtr,
    size_t* sVIdsPtrSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetSatellitesInfoEx
(
    taf_locGnss_SampleRef_t positionSampleRef,
    taf_locGnss_Constellation_t constellation,
    taf_locGnss_SvInfo_t* svInfoPtr,
    size_t* svInfoSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_SetMinGpsWeek
(
    uint16_t minGpsWeek
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetMinGpsWeek
(
    uint16_t* minGpsWeekPtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetCapabilities
(
    uint64_t* locCapabilityPtrPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_SetNmeaConfiguration
(
    taf_locGnss_NmeaBitMask_t nmeaMask,
    taf_locGnss_GeodeticDatumType_t datumType,
    taf_locGnss_LocEngineType_t engineType
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetXtraStatus
(
    taf_locGnss_XtraStatusParams_t * xtraParamsPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetGnssData
(
    taf_locGnss_SampleRef_t positionSampleRef,
    taf_locGnss_GnssData_t* gnssDataPtrPtr,
    size_t* gnssDataPtrSizePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_SetDRConfigValidity
(
    taf_locGnss_DRConfigValidityType_t validMask
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locGnss_GetGptpTime
(
    taf_locGnss_SampleRef_t positionSampleRef,
    uint64_t* gPtpTimePtr,
    uint64_t* gPtpTimeUncPtr
);

#endif // TAF_LOCGNSS_INTERFACE_H_INCLUDE_GUARD