RBRInstrumentMemory.h

Go to the documentation of this file.

 
#ifndef LIBRBR_RBRINSTRUMENTMEMORY_H
#define LIBRBR_RBRINSTRUMENTMEMORY_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define RBRINSTRUMENT_POSTPROCESSING_CHANNEL_MAX 24
 
typedef enum RBRInstrumentDataset
{
    RBRINSTRUMENT_DATASET_EASYPARSE_EVENTS = 0,
    RBRINSTRUMENT_DATASET_STANDARD = 1,
    RBRINSTRUMENT_DATASET_EASYPARSE_SAMPLE_DATA = 1,
    RBRINSTRUMENT_DATASET_EASYPARSE_DEPLOYMENT_HEADER = 2,
    RBRINSTRUMENT_DATASET_UNKNOWN_DATASET1 = 3,
    RBRINSTRUMENT_DATASET_POSTPROCESSING_SAMPLE_DATA = 4,
    RBRINSTRUMENT_DATASET_COUNT,
    RBRINSTRUMENT_UNKNOWN_DATASET
} RBRInstrumentDataset;
 
const char *RBRInstrumentDataset_name(RBRInstrumentDataset dataset);
 
typedef struct RBRInstrumentMemoryInfo
{
    RBRInstrumentDataset dataset;
    int32_t used;
    int32_t remaining;
    int32_t size;
} RBRInstrumentMemoryInfo;
 
RBRInstrumentError RBRInstrument_getMemoryInfo(
    RBRInstrument *instrument,
    RBRInstrumentMemoryInfo *memoryInfo);
 
typedef struct RBRInstrumentData
{
    RBRInstrumentDataset dataset;
    int32_t size;
    int32_t offset;
    void *data;
} RBRInstrumentData;
 
RBRInstrumentError RBRInstrument_readData(RBRInstrument *instrument,
                                          RBRInstrumentData *data);
 
RBRInstrumentError RBRInstrument_memoryClear(RBRInstrument *instrument);
 
typedef enum RBRInstrumentMemoryFormat
{
    RBRINSTRUMENT_MEMFORMAT_NONE     =      0,
    RBRINSTRUMENT_MEMFORMAT_RAWBIN00 = 1 << 0,
    RBRINSTRUMENT_MEMFORMAT_CALBIN00 = 1 << 1,
    RBRINSTRUMENT_MEMFORMAT_MAX      = RBRINSTRUMENT_MEMFORMAT_CALBIN00
} RBRInstrumentMemoryFormat;
 
const char *RBRInstrumentMemoryFormat_name(RBRInstrumentMemoryFormat format);
 
RBRInstrumentError RBRInstrument_getAvailableMemoryFormats(
    RBRInstrument *instrument,
    RBRInstrumentMemoryFormat *memoryFormats);
 
RBRInstrumentError RBRInstrument_getCurrentMemoryFormat(
    RBRInstrument *instrument,
    RBRInstrumentMemoryFormat *memoryFormat);
 
RBRInstrumentError RBRInstrument_getNewMemoryFormat(
    RBRInstrument *instrument,
    RBRInstrumentMemoryFormat *memoryFormat);
 
RBRInstrumentError RBRInstrument_setNewMemoryFormat(
    RBRInstrument *instrument,
    RBRInstrumentMemoryFormat memoryFormat);
 
typedef enum RBRInstrumentPostprocessingAggregate
{
    RBRINSTRUMENT_POSTPROCESSING_AGGREGATE_MEAN,
    RBRINSTRUMENT_POSTPROCESSING_AGGREGATE_STD,
    RBRINSTRUMENT_POSTPROCESSING_AGGREGATE_SAMPLE_COUNT,
    RBRINSTRUMENT_POSTPROCESSING_AGGREGATE_COUNT,
    RBRINSTRUMENT_UNKNOWN_POSTPROCESSING_AGGREGATE
} RBRInstrumentPostprocessingAggregate;
 
const char *RBRInstrumentPostprocessingAggregate_name(
    RBRInstrumentPostprocessingAggregate function);
 
typedef struct RBRInstrumentPostprocessingChannelsList
{
    int32_t count;
    struct
    {
        RBRInstrumentPostprocessingAggregate function;
        char label[RBRINSTRUMENT_CHANNEL_LABEL_MAX + 1];
    } channels[RBRINSTRUMENT_POSTPROCESSING_CHANNEL_MAX];
} RBRInstrumentPostprocessingChannelsList;
 
typedef enum RBRInstrumentPostprocessingStatus
{
    RBRINSTRUMENT_POSTPROCESSING_STATUS_IDLE,
    RBRINSTRUMENT_POSTPROCESSING_STATUS_PROCESSING,
    RBRINSTRUMENT_POSTPROCESSING_STATUS_COMPLETED,
    RBRINSTRUMENT_POSTPROCESSING_STATUS_ABORTED,
    RBRINSTRUMENT_POSTPROCESSING_STATUS_COUNT,
    RBRINSTRUMENT_UNKNOWN_POSTPROCESSING_STATUS
} RBRInstrumentPostprocessingStatus;
 
const char *RBRInstrumentPostprocessingStatus_name(
    RBRInstrumentPostprocessingStatus status);
 
typedef enum RBRInstrumentPostprocessingCommand
{
    RBRINSTRUMENT_POSTPROCESSING_COMMAND_START,
    RBRINSTRUMENT_POSTPROCESSING_COMMAND_RESET,
    RBRINSTRUMENT_POSTPROCESSING_COMMAND_ABORT,
    RBRINSTRUMENT_POSTPROCESSING_COMMAND_COUNT,
    RBRINSTRUMENT_UNKNOWN_POSTPROCESSING_COMMAND
} RBRInstrumentPostprocessingCommand;
 
const char *RBRInstrumentPostprocessingCommand_name(
    RBRInstrumentPostprocessingCommand command);
 
typedef enum RBRInstrumentPostprocessingBinFilter
{
    RBRINSTRUMENT_POSTPROCESSING_BINFILTER_NONE,
    RBRINSTRUMENT_POSTPROCESSING_BINFILTER_ASCENTONLY,
    RBRINSTRUMENT_POSTPROCESSING_BINFILTER_DESCENTONLY,
    RBRINSTRUMENT_POSTPROCESSING_BINFILTER_COUNT,
    RBRINSTRUMENT_UNKNOWN_POSTPROCESSING_BINFILTER
} RBRInstrumentPostprocessingBinFilter;
 
const char *RBRInstrumentPostprocessingBinFilter_name(
    RBRInstrumentPostprocessingBinFilter filter);
 
typedef struct RBRInstrumentPostprocessing
{
    RBRInstrumentPostprocessingStatus status;
    RBRInstrumentPostprocessingChannelsList channels;
    char binReference[RBRINSTRUMENT_CHANNEL_LABEL_MAX + 1];
    RBRInstrumentPostprocessingBinFilter binFilter;
    float binSize;
    RBRInstrumentDateTime tstampMin;
    RBRInstrumentDateTime tstampMax;
    float depthMin;
    float depthMax;
    float dcAlpha;
    float dcTau;
    float dcTdelay;
    float dcCtCoeff;
} RBRInstrumentPostprocessing;
 
RBRInstrumentError RBRInstrument_getPostprocessing(
    RBRInstrument *instrument,
    RBRInstrumentPostprocessing *postprocessing);
 
RBRInstrumentError RBRInstrument_setPostprocessing(
    RBRInstrument *instrument,
    const RBRInstrumentPostprocessing *postprocessing);
 
RBRInstrumentError RBRInstrument_setPostprocessingCommand(
    RBRInstrument *instrument,
    RBRInstrumentPostprocessingCommand command,
    RBRInstrumentPostprocessingStatus *status);
 
uint16_t calculateCrc(
    const void *data,
    int32_t size);   
 
#ifdef __cplusplus
}
#endif
 
#endif /* LIBRBR_RBRINSTRUMENTMEMORY_H */