How To Use Simulator Mode

Simulator Mode is a feature of the STFF::STFishFinder API. In Simulator Mode, a software module within the API simulates essential functions of a black box fish finder, and plays simulated data, to allow demonstration of the application's features in the absence of a black box.

To use the API in Simulator Mode, perform the following steps instead of the steps in the section How To Connect to a Black Box Fish Finder.

1. Create a STFishFinder class object for use in Simulator Mode.

Call CreateSimulatedFishFinder() to create an instance (object) of the STFishFinder class that is configured for simulated data.

2. Call Hello().

Call the Hello() member function. This will establish an internal API connection to a virtual black box fish finder module. It will also change the API status to FF_API_STATUS_READY, and will call the Callback_SettingChanged_t callback function.

3. (Optional) Call setters for Local Settings and Master Settings.

You may wish to customize the Local Settings and Master Settings when in simulator mode. In Simulator Mode, the Master Settings are themselves simulated, so changing them has no effect on any black box or other display units.

It is recommended that the Local Settings used when in Simulator Mode be distinct from the Local Settings used when connected to a black box fish finder. The user may prefer certain settings when using his black box in a favorite fishing spot, which he may not want to overwrite when experimenting in Simulator Mode. Therefore, if the application designer chooses to save Simulator Mode settings in persistent storage (e.g. flash memory or hard drive) on the display device, it is recommended that the Simulator Mode settings be stored separately from the settings used with a black box.

4. Call Control().

Call the Control() member function to begin the generation of simulated data messages by the API. The parameters to the Control() function specify which data messages the API should generate.

Note

In Simulator Mode, the API will only generate data messages in response to invocations of the STFF::STFishFinder::TimerTick() function. It is recommended that this function be called at a 10 Hz rate.