RBRInstrumentSchedule.h

Go to the documentation of this file.

 
#ifndef LIBRBR_RBRINSTRUMENTSCHEDULE_H
#define LIBRBR_RBRINSTRUMENTSCHEDULE_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define RBRINSTRUMENT_AVAILABLE_FAST_PERIODS_MAX 32
 
#define RBRINSTRUMENT_SAMPLING_PERIOD_MAX 86400000
 
typedef struct RBRInstrumentClock
{
    RBRInstrumentDateTime dateTime;
    float offsetFromUtc;
} RBRInstrumentClock;
 
RBRInstrumentError RBRInstrument_getClock(RBRInstrument *instrument,
                                          RBRInstrumentClock *clock);
 
RBRInstrumentError RBRInstrument_setClock(RBRInstrument *instrument,
                                          const RBRInstrumentClock *clock);
 
typedef enum RBRInstrumentSamplingMode
{
    RBRINSTRUMENT_SAMPLING_CONTINUOUS,
    RBRINSTRUMENT_SAMPLING_BURST,
    RBRINSTRUMENT_SAMPLING_WAVE,
    RBRINSTRUMENT_SAMPLING_AVERAGE,
    RBRINSTRUMENT_SAMPLING_TIDE,
    RBRINSTRUMENT_SAMPLING_REGIMES,
    RBRINSTRUMENT_SAMPLING_DDSAMPLING,
    RBRINSTRUMENT_SAMPLING_COUNT,
    RBRINSTRUMENT_UNKNOWN_SAMPLING
} RBRInstrumentSamplingMode;
 
const char *RBRInstrumentSamplingMode_name(RBRInstrumentSamplingMode mode);
 
typedef enum RBRInstrumentGate
{
    RBRINSTRUMENT_GATE_NONE,
    RBRINSTRUMENT_GATE_THRESHOLDING,
    RBRINSTRUMENT_GATE_TWISTACTIVATION,
    RBRINSTRUMENT_GATE_INVALID,
    RBRINSTRUMENT_GATE_COUNT,
    RBRINSTRUMENT_UNKNOWN_GATE
} RBRInstrumentGate;
 
const char *RBRInstrumentGate_name(RBRInstrumentGate gate);
 
typedef struct RBRInstrumentSampling
{
    RBRInstrumentSamplingMode mode;
    RBRInstrumentPeriod period;
    const RBRInstrumentPeriod
        availableFastPeriods[RBRINSTRUMENT_AVAILABLE_FAST_PERIODS_MAX];
    const RBRInstrumentPeriod userPeriodLimit;
    int32_t burstLength;
    RBRInstrumentPeriod burstInterval;
    RBRInstrumentGate gate;
} RBRInstrumentSampling;
 
RBRInstrumentError RBRInstrument_getSampling(
    RBRInstrument *instrument,
    RBRInstrumentSampling *sampling);
 
RBRInstrumentError RBRInstrument_setSampling(
    RBRInstrument *instrument,
    const RBRInstrumentSampling *sampling);
 
RBRInstrumentError RBRInstrument_setBurstSampling(
    RBRInstrument *instrument,
    const RBRInstrumentSampling *sampling);
 
typedef enum RBRInstrumentDeploymentStatus
{
    RBRINSTRUMENT_STATUS_DISABLED,
    RBRINSTRUMENT_STATUS_PENDING,
    RBRINSTRUMENT_STATUS_LOGGING,
    RBRINSTRUMENT_STATUS_GATED,
    RBRINSTRUMENT_STATUS_FINISHED,
    RBRINSTRUMENT_STATUS_STOPPED,
    RBRINSTRUMENT_STATUS_FULLANDSTOPPED,
    RBRINSTRUMENT_STATUS_FULL,
    RBRINSTRUMENT_STATUS_FAILED,
    RBRINSTRUMENT_STATUS_NOTBLANK,
    RBRINSTRUMENT_STATUS_UNKNOWN,
    RBRINSTRUMENT_STATUS_COUNT,
    RBRINSTRUMENT_UNKNOWN_STATUS
} RBRInstrumentDeploymentStatus;
 
const char *RBRInstrumentDeploymentStatus_name(
    RBRInstrumentDeploymentStatus status);
 
typedef struct RBRInstrumentDeployment
{
    RBRInstrumentDateTime startTime;
    RBRInstrumentDateTime endTime;
    const RBRInstrumentDeploymentStatus status;
} RBRInstrumentDeployment;
 
RBRInstrumentError RBRInstrument_getDeployment(
    RBRInstrument *instrument,
    RBRInstrumentDeployment *deployment);
 
RBRInstrumentError RBRInstrument_setDeployment(
    RBRInstrument *instrument,
    const RBRInstrumentDeployment *deployment);
 
#ifdef __cplusplus
}
#endif
 
#endif /* LIBRBR_RBRINSTRUMENTSCHEDULE_H */