taf_locPos_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_LOCPOS_INTERFACE_H_INCLUDE_GUARD
#define TAF_LOCPOS_INTERFACE_H_INCLUDE_GUARD


#include "legato.h"

// Interface specific includes
#include "taf_locGnss_interface.h"

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

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_locPos_ConnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locPos_TryConnectService
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_FULL_API void taf_locPos_SetServerDisconnectHandler
(
    taf_locPos_DisconnectHandler_t disconnectHandler,
    void *contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_FULL_API void taf_locPos_SetNonExitServerDisconnectHandler
(
    taf_locPos_DisconnectHandler_t disconnectHandler,
    void *contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_locPos_DisconnectService
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
taf_locPos_MovementHandlerRef_t taf_locPos_AddMovementHandler
(
    uint32_t horizontalMagnitude,
    uint32_t verticalMagnitude,
    taf_locPos_MovementHandlerFunc_t handlerPtr,
    void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_locPos_RemoveMovementHandler
(
    taf_locPos_MovementHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locPos_Get2DLocation
(
    int32_t* latitudePtr,
    int32_t* longitudePtr,
    int32_t* hAccuracyPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locPos_GetDate
(
    uint16_t* yearPtr,
    uint16_t* monthPtr,
    uint16_t* dayPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locPos_GetFixState
(
    taf_locGnss_FixState_t* statePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locPos_GetMotion
(
    uint32_t* hSpeedPtr,
    uint32_t* hSpeedAccuracyPtr,
    int32_t* vSpeedPtr,
    int32_t* vSpeedAccuracyPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locPos_GetDirection
(
    uint32_t* directionPtr,
    uint32_t* directionAccuracyPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locPos_GetTime
(
    uint16_t* hoursPtr,
    uint16_t* minutesPtr,
    uint16_t* secondsPtr,
    uint16_t* millisecondsPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locPos_SetAcquisitionRate
(
    uint32_t acquisitionRate
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
uint32_t taf_locPos_GetAcquisitionRate
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void taf_locPos_sample_Release
(
    taf_locPos_SampleRef_t positionSampleRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locPos_Get3DLocation
(
    int32_t* latitudePtr,
    int32_t* longitudePtr,
    int32_t* hAccuracyPtr,
    int32_t* altitudePtr,
    int32_t* vAccuracyPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locPos_sample_Get2DLocation
(
    taf_locPos_SampleRef_t positionSampleRef,
    int32_t* latitudePtr,
    int32_t* longitudePtr,
    int32_t* horizontalAccuracyPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locPos_sample_GetAltitude
(
    taf_locPos_SampleRef_t positionSampleRef,
    int32_t* altitudePtr,
    int32_t* altitudeAccuracyPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locPos_sample_GetTime
(
    taf_locPos_SampleRef_t positionSampleRef,
    uint16_t* hoursPtr,
    uint16_t* minutesPtr,
    uint16_t* secondsPtr,
    uint16_t* millisecondsPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locPos_sample_GetHorizontalSpeed
(
    taf_locPos_SampleRef_t positionSampleRef,
    uint32_t* hSpeedPtr,
    uint32_t* hSpeedAccuracyPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locPos_sample_GetDirection
(
    taf_locPos_SampleRef_t positionSampleRef,
    uint32_t* directionPtr,
    uint32_t* directionAccuracyPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locPos_sample_GetVerticalSpeed
(
    taf_locPos_SampleRef_t positionSampleRef,
    int32_t* vspeedPtr,
    int32_t* vspeedAccuracyPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locPos_SetDistanceResolution
(
    taf_locPos_Resolution_t resolution
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locPos_sample_GetFixState
(
    taf_locPos_SampleRef_t positionSampleRef,
    taf_locGnss_FixState_t* statePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t taf_locPos_sample_GetDate
(
    taf_locPos_SampleRef_t positionSampleRef,
    uint16_t* yearPtr,
    uint16_t* monthPtr,
    uint16_t* dayPtr
);

#endif // TAF_LOCPOS_INTERFACE_H_INCLUDE_GUARD