taf_locPos_common.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_COMMON_H_INCLUDE_GUARD
#define TAF_LOCPOS_COMMON_H_INCLUDE_GUARD


#include "legato.h"

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

#define IFGEN_TAF_LOCPOS_PROTOCOL_ID "7524055dcdb06eb2aa3fcec77b6f8445"
#define IFGEN_TAF_LOCPOS_MSG_SIZE 32



//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define TAF_LOCPOS_TAF_LOCPOS_MAX_OBJ 1

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_locPos_Sample* taf_locPos_SampleRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct taf_locPos_MovementHandler* taf_locPos_MovementHandlerRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    TAF_LOCPOS_RES_METER = 0,
    TAF_LOCPOS_RES_DECIMETER = 1,
    TAF_LOCPOS_RES_CENTIMETER = 2,
    TAF_LOCPOS_RES_MILLIMETER = 3,
    TAF_LOCPOS_RES_UNKNOWN = 4
}
taf_locPos_Resolution_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*taf_locPos_MovementHandlerFunc_t)
(
        taf_locPos_SampleRef_t positionSampleRef,
        void* contextPtr
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED bool ifgen_taf_locPos_HasLocalBinding
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_locPos_InitCommonData
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_locPos_CleanupCommonData
(
    le_msg_SessionRef_t _ifgen_sessionRef
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_locPos_OpenSession
(
    le_msg_SessionRef_t _ifgen_sessionRef,
    bool isBlocking
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED taf_locPos_MovementHandlerRef_t ifgen_taf_locPos_AddMovementHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint32_t horizontalMagnitude,
        uint32_t verticalMagnitude,
        taf_locPos_MovementHandlerFunc_t handlerPtr,
        void* contextPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_locPos_RemoveMovementHandler
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_locPos_MovementHandlerRef_t handlerRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_locPos_Get2DLocation
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        int32_t* latitudePtr,
        int32_t* longitudePtr,
        int32_t* hAccuracyPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_locPos_GetDate
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint16_t* yearPtr,
        uint16_t* monthPtr,
        uint16_t* dayPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_locPos_GetFixState
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_locGnss_FixState_t* statePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_locPos_GetMotion
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint32_t* hSpeedPtr,
        uint32_t* hSpeedAccuracyPtr,
        int32_t* vSpeedPtr,
        int32_t* vSpeedAccuracyPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_locPos_GetDirection
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint32_t* directionPtr,
        uint32_t* directionAccuracyPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_locPos_GetTime
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint16_t* hoursPtr,
        uint16_t* minutesPtr,
        uint16_t* secondsPtr,
        uint16_t* millisecondsPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_locPos_SetAcquisitionRate
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        uint32_t acquisitionRate
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED uint32_t ifgen_taf_locPos_GetAcquisitionRate
(
    le_msg_SessionRef_t _ifgen_sessionRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED void ifgen_taf_locPos_sample_Release
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_locPos_SampleRef_t positionSampleRef
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_locPos_Get3DLocation
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        int32_t* latitudePtr,
        int32_t* longitudePtr,
        int32_t* hAccuracyPtr,
        int32_t* altitudePtr,
        int32_t* vAccuracyPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_locPos_sample_Get2DLocation
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_locPos_SampleRef_t positionSampleRef,
        int32_t* latitudePtr,
        int32_t* longitudePtr,
        int32_t* horizontalAccuracyPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_locPos_sample_GetAltitude
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_locPos_SampleRef_t positionSampleRef,
        int32_t* altitudePtr,
        int32_t* altitudeAccuracyPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_locPos_sample_GetTime
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_locPos_SampleRef_t positionSampleRef,
        uint16_t* hoursPtr,
        uint16_t* minutesPtr,
        uint16_t* secondsPtr,
        uint16_t* millisecondsPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_locPos_sample_GetHorizontalSpeed
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_locPos_SampleRef_t positionSampleRef,
        uint32_t* hSpeedPtr,
        uint32_t* hSpeedAccuracyPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_locPos_sample_GetDirection
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_locPos_SampleRef_t positionSampleRef,
        uint32_t* directionPtr,
        uint32_t* directionAccuracyPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_locPos_sample_GetVerticalSpeed
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_locPos_SampleRef_t positionSampleRef,
        int32_t* vspeedPtr,
        int32_t* vspeedAccuracyPtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_locPos_SetDistanceResolution
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_locPos_Resolution_t resolution
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_locPos_sample_GetFixState
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_locPos_SampleRef_t positionSampleRef,
        taf_locGnss_FixState_t* statePtr
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_SHARED le_result_t ifgen_taf_locPos_sample_GetDate
(
    le_msg_SessionRef_t _ifgen_sessionRef,
        taf_locPos_SampleRef_t positionSampleRef,
        uint16_t* yearPtr,
        uint16_t* monthPtr,
        uint16_t* dayPtr
);

#endif // TAF_LOCPOS_COMMON_H_INCLUDE_GUARD