le_pos.h

Go to the documentation of this file.

#ifndef LEGATO_POS_INCLUDE_GUARD
#define LEGATO_POS_INCLUDE_GUARD

#include "legato.h"



//--------------------------------------------------------------------------------------------------
// APIs.
//--------------------------------------------------------------------------------------------------

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_pos_Sample* le_pos_SampleRef_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_pos_MovementHandler* le_pos_MovementHandlerRef_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void(*le_pos_MovementHandlerFunc_t)
(
    le_pos_SampleRef_t    positionSampleRef,
    void*                 contextPtr
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_pos_MovementHandlerRef_t le_pos_AddMovementHandler
(
    uint32_t                     horizontalMagnitude, 
    uint32_t                     verticalMagnitude,   
    le_pos_MovementHandlerFunc_t handlerPtr,          
    void*                        contextPtr           
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_pos_RemoveMovementHandler
(
    le_pos_MovementHandlerRef_t    handlerRef 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_pos_sample_Get2DLocation
(
    le_pos_SampleRef_t  positionSampleRef,    
    int32_t*            latitudePtr,          
    int32_t*            longitudePtr,         
    int32_t*            horizontalAccuracyPtr 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_pos_sample_GetAltitude
(
    le_pos_SampleRef_t  positionSampleRef,   
    int32_t*            altitudePtr,         
    int32_t*            altitudeAccuracyPtr  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_pos_sample_GetHorizontalSpeed
(
    le_pos_SampleRef_t  positionSampleRef, 
    uint32_t*           hSpeedPtr,         
    int32_t*            hSpeedAccuracyPtr  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_pos_sample_GetVerticalSpeed
(
    le_pos_SampleRef_t  positionSampleRef, 
    int32_t*            vSpeedPtr,         
    int32_t*            vSpeedAccuracyPtr  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_pos_sample_GetHeading
(
    le_pos_SampleRef_t positionSampleRef, 
    int32_t*           headingPtr,        
    int32_t*           headingAccuracyPtr 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_pos_sample_GetDirection
(
    le_pos_SampleRef_t positionSampleRef,   
    int32_t*           directionPtr,        
    int32_t*           directionAccuracyPtr 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_pos_sample_Release
(
    le_pos_SampleRef_t    positionSampleRef    
);

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

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

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

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_pos_GetHeading
(
    int32_t*  headingPtr,        
    int32_t*  headingAccuracyPtr 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_pos_GetDirection
(
    int32_t* directionPtr,        
    int32_t* directionAccuracyPtr 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_pos_LoadXtra
(
    const char* xtraFilePathPtr    
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_pos_GetXtraValidity
(
    le_clk_Time_t *startTimePtr,    
    le_clk_Time_t *stopTimePtr      
);

#endif // LEGATO_POS_INCLUDE_GUARD