tsc_Instrument

The base class representing any sort of survey position sensor.  At present there are three subclasses:

• • tsc_NoInstrument - returned when none is available.

  • tsc_TsInstrument - any kind of optical instrument.

  • tsc_GnssInstrument - a GNSS receiver.

Public methods

bool IsTs()  const;
True if the instrument is a Total station.

bool IsGnss() const;
True if the instrument is a GNSS device.

tsc_TsInstrument& AsTs() const;
Cast to a Total station.

tsc_GnssInstrument& AsGnss() const;
Cast to a GNSS device.

bool Connected() const;
A connection to the device has been established.

bool Starting() const;
Doing station setup or starting survey.

bool Running() const;
Survey has been started and is able to measure and store points.

Static methods

static tsc_Instrument CurrentInstrument ();
Request the current display instrument (not the same as the tsc_UITask::TaskInstrument).

static bool ToggleCurrentInstrument();
Toggle between connected sensors, returns true if the sensor changed.

static bool ChangeCurrentInstrument(const tsc_Instrument& changeTo);
Make the specified instrument the current display sensor, returns true if the sensor changed.  This will not change the instrument assigned to a UITask, use tsc_UITask::SetTaskInstrument to achieve this.