sbgEComLogSat.h

Go to the documentation of this file.

 
#ifndef SBG_ECOM_LOG_SAT_H
#define SBG_ECOM_LOG_SAT_H
 
// sbgCommonLib headers
#include <sbgCommon.h>
#include <streamBuffer/sbgStreamBuffer.h>
 
// Project headers
#include <defs/sbgEComDefsGnss.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
//----------------------------------------------------------------------//
//- Constant definitions                                               -//
//----------------------------------------------------------------------//

#define SBG_ECOM_SAT_MAX_NR_SATELLITES                      (64)

#define SBG_ECOM_SAT_MAX_NR_SIGNALS                         (8)
 
//----------------------------------------------------------------------//
//- Enumeration definitions                                            -//
//----------------------------------------------------------------------//

typedef enum _SbgEComSatTrackingStatus
{
    SBG_ECOM_SAT_TRACKING_STATUS_UNKNOWN            = 0,                            
    SBG_ECOM_SAT_TRACKING_STATUS_SEARCHING            = 1,                            
    SBG_ECOM_SAT_TRACKING_STATUS_TRACKING_UNKNOWN  = 2,                            
    SBG_ECOM_SAT_TRACKING_STATUS_TRACKING_NOT_USED    = 3,                            
    SBG_ECOM_SAT_TRACKING_STATUS_TRACKING_REJECTED    = 4,                            
    SBG_ECOM_SAT_TRACKING_STATUS_TRACKING_USED        = 5,                            
} SbgEComSatTrackingStatus;

typedef enum _SbgEComSatHealthStatus
{
    SBG_ECOM_SAT_HEALTH_STATUS_UNKNOWN                = 0,                            
    SBG_ECOM_SAT_HEALTH_STATUS_HEALTHY                = 1,                            
    SBG_ECOM_SAT_HEALTH_STATUS_UNHEALTHY            = 2,                            
} SbgEComSatHealthStatus;

typedef enum _SbgEComSatElevationStatus
{
    SBG_ECOM_SAT_ELEVATION_STATUS_UNKNOWN          = 0,                            
    SBG_ECOM_SAT_ELEVATION_STATUS_SETTING          = 1,                            
    SBG_ECOM_SAT_ELEVATION_STATUS_RISING            = 2,                            
} SbgEComSatElevationStatus;
 
//----------------------------------------------------------------------//
//- Structure definitions                                              -//
//----------------------------------------------------------------------//

typedef struct _SbgEComLogSatSignal
{
    SbgEComSignalId                       id;                                      
    uint8_t                              flags;                                        
    uint8_t                              snr;                                        
} SbgEComLogSatSignal;

typedef struct _SbgEComLogSatEntry
{
    uint8_t                             id;                                           
    int8_t                              elevation;                                 
    uint16_t                            azimuth;                                 
    uint16_t                            flags;                                     
    size_t                              nrSignals;                                 
    SbgEComLogSatSignal                  signalData[SBG_ECOM_SAT_MAX_NR_SIGNALS];   
} SbgEComLogSatEntry;

typedef struct _SbgEComLogSatList
{
    uint32_t                            timeStamp;                                 
    uint32_t                            reserved;                                   
    size_t                              nrSatellites;                               
    SbgEComLogSatEntry                    satData[SBG_ECOM_SAT_MAX_NR_SATELLITES];   
} SbgEComLogSatList;
 
//----------------------------------------------------------------------//
//- Public setters/getters (SbgEComLogSatSignal)                       -//
//----------------------------------------------------------------------//

const char *sbgEComLogSatSignalGetSignalIdAsStr(const SbgEComLogSatSignal *pSignalData);

bool sbgEComLogSatSignalSnrIsValid(const SbgEComLogSatSignal *pSignalData);

SbgEComSatHealthStatus sbgEComLogSatSignalGetHealthStatus(const SbgEComLogSatSignal *pSignalData);

const char *sbgEComLogSatSignalGetHealthStatusAsStr(const SbgEComLogSatSignal *pSignalData);

SbgEComSatTrackingStatus sbgEComLogSatSignalGetTrackingStatus(const SbgEComLogSatSignal *pSignalData);

const char *sbgEComLogSatSignalGetTrackingStatusAsStr(const SbgEComLogSatSignal *pSignalData);
 
//----------------------------------------------------------------------//
//- Public methods (SbgEComLogSatEntry)                                -//
//----------------------------------------------------------------------//

SbgEComLogSatSignal *sbgEComLogSatEntryAdd(SbgEComLogSatEntry *pSatData, SbgEComSignalId id, SbgEComSatHealthStatus healthStatus, SbgEComSatTrackingStatus trackingStatus, bool snrValid, uint8_t snr);
 
//----------------------------------------------------------------------//
//- Public setters/getters (SbgEComLogSatEntry)                        -//
//----------------------------------------------------------------------//

SbgEComLogSatSignal *sbgEComLogSatEntryGet(SbgEComLogSatEntry *pSatData, SbgEComSignalId id);

SbgEComConstellationId sbgEComLogSatEntryGetConstellationId(const SbgEComLogSatEntry *pSatData);

const char *sbgEComLogSatEntryGetConstellationIdAsStr(const SbgEComLogSatEntry *pSatData);

SbgEComSatElevationStatus sbgEComLogSatEntryGetElevationStatus(const SbgEComLogSatEntry *pSatData);

const char *sbgEComLogSatEntryGetElevationStatusAsStr(const SbgEComLogSatEntry *pSatData);

SbgEComSatHealthStatus sbgEComLogSatEntryGetHealthStatus(const SbgEComLogSatEntry *pSatData);

const char *sbgEComLogSatEntryGetHealthStatusAsStr(const SbgEComLogSatEntry *pSatData);

SbgEComSatTrackingStatus sbgEComLogSatEntryGetTrackingStatus(const SbgEComLogSatEntry *pSatData);

const char *sbgEComLogSatEntryGetTrackingStatusAsStr(const SbgEComLogSatEntry *pSatData);
 
//----------------------------------------------------------------------//
//- Public methods (SbgEComLogSatList)                                 -//
//----------------------------------------------------------------------//

void sbgEComLogSatListConstruct(SbgEComLogSatList *pSatList, uint32_t timeStamp);

SbgEComLogSatEntry *sbgEComLogSatListAdd(SbgEComLogSatList *pSatList, uint8_t id, int8_t elevation, uint16_t azimuth, SbgEComConstellationId constellationId, SbgEComSatElevationStatus elevationStatus, SbgEComSatHealthStatus healthStatus, SbgEComSatTrackingStatus trackingStatus);

SbgErrorCode sbgEComLogSatListReadFromStream(SbgEComLogSatList *pSatList, SbgStreamBuffer *pStreamBuffer);

SbgErrorCode sbgEComLogSatListWriteToStream(const SbgEComLogSatList *pSatList, SbgStreamBuffer *pStreamBuffer);
 
//----------------------------------------------------------------------//
//- Public setters/getters (SbgEComLogSatList)                         -//
//----------------------------------------------------------------------//

SbgEComLogSatEntry *sbgEComLogSatListGet(SbgEComLogSatList *pSatList, uint8_t id);
 
//----------------------------------------------------------------------//
//- DEPRECATED - Used for backward compatibility                       -//
//----------------------------------------------------------------------//
 
SBG_DEPRECATED_TYPEDEF(typedef struct _SbgEComLogSatSignal    SbgLogSatSignalData);
SBG_DEPRECATED_TYPEDEF(typedef struct _SbgEComLogSatEntry  SbgLogSatData);
SBG_DEPRECATED_TYPEDEF(typedef struct _SbgEComLogSatList    SbgLogSatGroupData);
 
SBG_DEPRECATED(SbgErrorCode sbgEComBinaryLogParseSatGroupData(SbgStreamBuffer *pStreamBuffer, SbgEComLogSatList *pSatList));
SBG_DEPRECATED(SbgErrorCode sbgEComBinaryLogWriteSatGroupData(SbgStreamBuffer *pStreamBuffer, const SbgEComLogSatList *pSatList));
 
#ifdef __cplusplus
}
#endif
 
#endif // SBG_ECOM_LOG_SAT_H