libRBR v1.2.3
RBR instrument communication API
Data Fields
RBRInstrumentDeployment Struct Reference

Instrument deployment command parameters. More...

#include <RBRInstrumentSchedule.h>

Data Fields

RBRInstrumentDateTime startTime
 The deployment start date and time. More...
 
RBRInstrumentDateTime endTime
 The deployment end date and time. More...
 
const RBRInstrumentDeploymentStatus status
 The deployment status. More...
 

Detailed Description

Instrument deployment command parameters.

See also
RBRInstrument_getDeployment()
RBRInstrument_setDeployment()
https://docs.rbr-global.com/L3commandreference/commands/time-and-schedule/deployment

Field Documentation

◆ endTime

RBRInstrumentDateTime RBRInstrumentDeployment::endTime

The deployment end date and time.

Must be after the start time.

◆ startTime

RBRInstrumentDateTime RBRInstrumentDeployment::startTime

The deployment start date and time.

Must be before the end time.

◆ status

const RBRInstrumentDeploymentStatus RBRInstrumentDeployment::status

The deployment status.

The corresponding instrument parameter is read-only. This member is used only when reading parameters from the instrument; its value is ignored when sending parameters to the instrument.


The documentation for this struct was generated from the following file: