tsc_ITsFace2ButtonMonitor

This interface is used to handle the button presses generated by the buttons located on the 2nd face of supported Trimble total stations.

Some of the total stations that Survey Core can connect to have a LCD display available on the 2nd face of the instrument.  These typically provide access to the data when using a attached controller on the first face.  They can sometimes be used to access the instrument setup as well.

SCAPI supports the LCD screen with tsc_TsFace2Display which allows control of the image displayed.

This monitor class allows you to intercept button press events as they occur.  The events only occur when the monitored display is active, if some other Face2 display is active (such as the electronic level) then your monitor will not receive the events.

Starting and stopping the monitor

void  Start (tsc_TsFace2Display& display);

Starts monitoring events that occur on the current display.  Calling Start multiple times is not an error, calling Start on a different display is not accepted.  Please use Stop when switching between different displays.

void  Stop  (tsc_TsFace2Display& display);

Stops event handling for the current job.  If events were never started this is not an error.  If the current, started display is a different display then an assert occurs.  Please use Stop when switching between different displays.

Enumerations

tsc_Face2Button

    tsc_Face2Button_Unknown

    tsc_Face2Button_SSeriesButtonChangeFace

    tsc_Face2Button_SSeriesButtonMiddle

    tsc_Face2Button_SSeriesButtonEnter

    tsc_Face2Button_SSeriesButtonSideEnter

    tsc_Face2Button_M3ButtonF1

    tsc_Face2Button_M3ButtonMsr

    tsc_Face2Button_M3ButtonEnter

Locations

Event handlers

virtual bool OnButtonPressed (tsc_Face2Button buttonPress);

This event is whenever a Face 2 button is pressed when the display is active.  Return true to indicate that you have consumed the press event.  Return false if you wish to indicate that the system should perform the default behaviour for that button.