RBRInstrumentVehicle.h

Go to the documentation of this file.

 
#ifndef LIBRBR_RBRINSTRUMENTVEHICLE_H
#define LIBRBR_RBRINSTRUMENTVEHICLE_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define RBRINSTRUMENT_REGIME_MAX 3
 
#define RBRINSTRUMENT_REGIME_BOUNDARY_MAX 65535
 
#define RBRINSTRUMENT_REGIME_BINSIZE_MAX 6553.5
 
#define RBRINSTRUMENT_REGIME_SAMPLING_PERIOD_MAX 65000
 
typedef enum RBRInstrumentDirection
{
    RBRINSTRUMENT_DIRECTION_ASCENDING,
    RBRINSTRUMENT_DIRECTION_DESCENDING,
    RBRINSTRUMENT_DIRECTION_COUNT,
    RBRINSTRUMENT_UNKNOWN_DIRECTION
} RBRInstrumentDirection;
 
const char *RBRInstrumentDirection_name(RBRInstrumentDirection direction);
 
typedef enum RBRInstrumentRegimesReference
{
    RBRINSTRUMENT_REFERENCE_ABSOLUTE,
    RBRINSTRUMENT_REFERENCE_SEAPRESSURE,
    RBRINSTRUMENT_REFERENCE_COUNT,
    RBRINSTRUMENT_UNKNOWN_REFERENCE
} RBRInstrumentRegimesReference;
 
const char *RBRInstrumentRegimesReference_name(
    RBRInstrumentRegimesReference reference);
 
typedef struct RBRInstrumentRegimes
{
    RBRInstrumentDirection direction;
    int32_t count;
    RBRInstrumentRegimesReference reference;
} RBRInstrumentRegimes;
 
RBRInstrumentError RBRInstrument_getRegimes(
    RBRInstrument *instrument,
    RBRInstrumentRegimes *regimes);
 
RBRInstrumentError RBRInstrument_setRegimes(
    RBRInstrument *instrument,
    const RBRInstrumentRegimes *regimes);
 
typedef uint8_t RBRInstrumentRegimeIndex;
 
typedef struct RBRInstrumentRegime
{
    RBRInstrumentRegimeIndex index;
    float boundary;
    float binSize;
    RBRInstrumentPeriod samplingPeriod;
} RBRInstrumentRegime;
 
RBRInstrumentError RBRInstrument_getRegime(
    RBRInstrument *instrument,
    RBRInstrumentRegime *regime);
 
RBRInstrumentError RBRInstrument_setRegime(
    RBRInstrument *instrument,
    const RBRInstrumentRegime *regime);
 
typedef struct RBRInstrumentDirectionDependentSampling
{
    RBRInstrumentDirection direction;
    RBRInstrumentPeriod fastPeriod;
    RBRInstrumentPeriod slowPeriod;
    float fastThreshold;
    float slowThreshold;
} RBRInstrumentDirectionDependentSampling;
 
RBRInstrumentError RBRInstrument_getDirectionDependentSampling(
    RBRInstrument *instrument,
    RBRInstrumentDirectionDependentSampling *ddsampling);
 
RBRInstrumentError RBRInstrument_setDirectionDependentSampling(
    RBRInstrument *instrument,
    RBRInstrumentDirectionDependentSampling *ddsampling);
 
#ifdef __cplusplus
}
#endif
 
#endif /* LIBRBR_RBRINSTRUMENTVEHICLE_H */