libRBR  v1.2.3
RBR instrument communication API
RBRInstrumentDeployment.h
Go to the documentation of this file.
1 
13 #ifndef LIBRBR_RBRINSTRUMENTDEPLOYMENT_H
14 #define LIBRBR_RBRINSTRUMENTDEPLOYMENT_H
15 
16 #ifdef __cplusplus
17 extern "C" {
18 #endif
19 
43  RBRInstrument *instrument,
44  bool eraseMemory,
46 
67  RBRInstrument *instrument,
68  bool eraseMemory,
70 
82  RBRInstrument *instrument,
84 
93 {
95  bool state;
103 
116  RBRInstrument *instrument,
117  RBRInstrumentSimulation *simulation);
118 
141  RBRInstrument *instrument,
142  const RBRInstrumentSimulation *simulation);
143 
144 #ifdef __cplusplus
145 }
146 #endif
147 
148 #endif /* LIBRBR_RBRINSTRUMENTDEPLOYMENT_H */
RBRInstrument_getSimulation
RBRInstrumentError RBRInstrument_getSimulation(RBRInstrument *instrument, RBRInstrumentSimulation *simulation)
Get the instrument simulation settings.
RBRInstrument_disable
RBRInstrumentError RBRInstrument_disable(RBRInstrument *instrument, RBRInstrumentDeploymentStatus *status)
If the instrument is logging, terminate the current deployment.
RBRInstrumentDeploymentStatus
RBRInstrumentDeploymentStatus
Possible instrument logging statuses.
Definition: RBRInstrumentSchedule.h:367
RBRInstrument_enable
RBRInstrumentError RBRInstrument_enable(RBRInstrument *instrument, bool eraseMemory, RBRInstrumentDeploymentStatus *status)
Enable the instrument to sample according to the programmed schedule.
RBRInstrumentPeriod
int32_t RBRInstrumentPeriod
A periodic parameter.
Definition: RBRInstrument.h:191
RBRInstrument_setSimulation
RBRInstrumentError RBRInstrument_setSimulation(RBRInstrument *instrument, const RBRInstrumentSimulation *simulation)
Set the instrument simulation settings.
RBRInstrumentError
RBRInstrumentError
Errors which can be returned from library functions.
Definition: RBRInstrument.h:200
RBRInstrumentSimulation::state
bool state
Definition: RBRInstrumentDeployment.h:95
RBRInstrument_verify
RBRInstrumentError RBRInstrument_verify(RBRInstrument *instrument, bool eraseMemory, RBRInstrumentDeploymentStatus *status)
Perform a “dry run” of the enable command.
RBRInstrumentSimulation
struct RBRInstrumentSimulation RBRInstrumentSimulation
Instrument simulation command parameters.
RBRInstrumentSimulation::period
RBRInstrumentPeriod period
Definition: RBRInstrumentDeployment.h:101
RBRInstrument
Core library context object.
Definition: RBRInstrument.h:591
RBRInstrumentSimulation
Instrument simulation command parameters.
Definition: RBRInstrumentDeployment.h:92