 |
libRBR
v1.2.3
RBR instrument communication API
|
Go to the documentation of this file.
13 #ifndef LIBRBR_RBRINSTRUMENTGATING_H
14 #define LIBRBR_RBRINSTRUMENTGATING_H
RBRInstrumentChannelIndex channelIndex
The index of the channel to use for the threshold check.
Definition: RBRInstrumentGating.h:137
@ RBRINSTRUMENT_UNKNOWN_THRESHOLDING
Definition: RBRInstrumentGating.h:84
RBRInstrumentThresholdingChannelSelection
Means of instrument thresholding channel selection.
Definition: RBRInstrumentGating.h:50
@ RBRINSTRUMENT_GATING_RUNNING
Logging is running due to the gating.
Definition: RBRInstrumentGating.h:28
struct RBRInstrumentThresholding RBRInstrumentThresholding
Instrument thresholding command parameters.
RBRInstrumentThresholdingCondition condition
Specifies the condition under which sampling will occur.
Definition: RBRInstrumentGating.h:153
@ RBRINSTRUMENT_THRESHOLD_CHANNEL_BY_LABEL
Definition: RBRInstrumentGating.h:55
const char * RBRInstrumentThresholdingCondition_name(RBRInstrumentThresholdingCondition condition)
Get a human-readable string name for a thresholding condition.
const RBRInstrumentGatingState state
The state of logging based on the thresholding configuration.
Definition: RBRInstrumentGating.h:115
const char * RBRInstrumentThresholdingChannelSelection_name(RBRInstrumentThresholdingChannelSelection selection)
Get a human-readable string name for a means of thresholding channel selection.
#define RBRINSTRUMENT_CHANNEL_LABEL_MAX
The maximum number of characters in a channel label.
Definition: RBRInstrument.h:131
struct RBRInstrumentTwistActivation RBRInstrumentTwistActivation
Instrument twistactivation command parameters.
const char * RBRInstrumentGatingState_name(RBRInstrumentGatingState state)
Get a human-readable string name for a gating state.
@ RBRINSTRUMENT_THRESHOLDING_BELOW
Definition: RBRInstrumentGating.h:80
int32_t RBRInstrumentPeriod
A periodic parameter.
Definition: RBRInstrument.h:191
float value
The threshold value in calibrated units.
Definition: RBRInstrumentGating.h:155
bool enabled
Enables or disables thresholding.
Definition: RBRInstrumentGating.h:107
Instrument twistactivation command parameters.
Definition: RBRInstrumentGating.h:212
const RBRInstrumentGatingState state
The state of logging based on the twist activation configuration.
Definition: RBRInstrumentGating.h:223
RBRInstrumentPeriod interval
The interval between threshold checks.
Definition: RBRInstrumentGating.h:163
RBRInstrumentError
Errors which can be returned from library functions.
Definition: RBRInstrument.h:200
Instrument thresholding command parameters.
Definition: RBRInstrumentGating.h:104
RBRInstrumentError RBRInstrument_setTwistActivation(RBRInstrument *instrument, const RBRInstrumentTwistActivation *twistActivation)
Set the instrument twist activation settings.
RBRInstrumentError RBRInstrument_getThresholding(RBRInstrument *instrument, RBRInstrumentThresholding *threshold)
Get the instrument thresholding settings.
@ RBRINSTRUMENT_GATING_COUNT
Definition: RBRInstrumentGating.h:30
@ RBRINSTRUMENT_THRESHOLD_CHANNEL_BY_INDEX
Definition: RBRInstrumentGating.h:53
@ RBRINSTRUMENT_THRESHOLDING_COUNT
Definition: RBRInstrumentGating.h:82
@ RBRINSTRUMENT_THRESHOLDING_ABOVE
Definition: RBRInstrumentGating.h:78
char channelLabel[RBRINSTRUMENT_CHANNEL_LABEL_MAX+1]
The label of the channel to use for the threshold check.
Definition: RBRInstrumentGating.h:151
RBRInstrumentError RBRInstrument_setThresholding(RBRInstrument *instrument, const RBRInstrumentThresholding *threshold)
Set the instrument thresholding settings.
RBRInstrumentGatingState
The state of a gating condition.
Definition: RBRInstrumentGating.h:21
bool enabled
Enables or disables twist activation.
Definition: RBRInstrumentGating.h:215
@ RBRINSTRUMENT_GATING_PAUSED
Logging is paused due to the gating.
Definition: RBRInstrumentGating.h:26
Core library context object.
Definition: RBRInstrument.h:591
@ RBRINSTRUMENT_UNKNOWN_GATING
Definition: RBRInstrumentGating.h:32
RBRInstrumentError RBRInstrument_getTwistActivation(RBRInstrument *instrument, RBRInstrumentTwistActivation *twistActivation)
Get the instrument twist activation settings.
RBRInstrumentThresholdingChannelSelection channelSelection
Whether the thresholding channel should be configured by index or by label.
Definition: RBRInstrumentGating.h:129
RBRInstrumentThresholdingCondition
Possible instrument thresholding conditions.
Definition: RBRInstrumentGating.h:75
@ RBRINSTRUMENT_GATING_NA
The gating condition is disabled.
Definition: RBRInstrumentGating.h:24
uint8_t RBRInstrumentChannelIndex
A channel identifier.
Definition: RBRInstrumentConfiguration.h:88