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