STFishFinder API  API version 0.0.0, Documentation version 3 -PRELIMINARY-
Global Enumerations

These are type definitions for enumerations in the global namespace. More...

Enumerations

enum  FF_Error_t
 Error codes. More...
 
enum  FF_Frequency_t
 Sonar Frequency options. More...
 
enum  FF_DepthUnits_t
 Depth Units selection. More...
 
enum  FF_SpeedUnits_t
 Speed Units selection. More...
 
enum  FF_TemperatureUnits_t
 Temperature Units selection. More...
 
enum  FF_SettingType_t
 Setting Type options. More...
 
enum  FF_SettingStatus_t
 Setting Status options. More...
 
enum  FF_DataType_t
 Data Type options. More...
 
enum  FF_DataStatus_t
 Data Status options. More...
 
enum  FF_ControlCommand_t
 Control Command options. More...
 
enum  FF_ControlEnableBlackBoxMsg_t
 Control command parameter options for use with the FF_CONTROL_COMMAND_ENABLE_BLACK_BOX_MESSAGES option when calling STFF::STFishFinder::Control(). More...
 
enum  FF_FrequencyMode_t
 Sonar Frequency Mode options. More...
 
enum  FF_AutoRangeSetting_t
 Auto Range setting options. More...
 
enum  FF_AutoGainSetting_t
 Auto Gain setting options. More...
 
enum  FF_DepthAlarmType_t
 Depth Alarm Type selection. More...
 
enum  FF_DepthAlarmState_t
 Depth Alarm State options. More...
 
enum  FF_ApiStatus_t
 API Status selection. More...
 

Detailed Description

These are type definitions for enumerations in the global namespace.

Remarks
These have been placed in the global namespace to simplify linking with application code written in languages that do not support namespaces.

Enumeration Type Documentation

#include <STFF-Types.h>

API Status selection.

This is a type definition for an enumeration specifying the status of the STFishFinder API. This enumeration resides in the global namespace.

See also
STFF::STFishFinder::GetApiStatus()
STFF::valid(FF_ApiStatus_t)
Enumerator
FF_API_STATUS_READY 

Initialization has completed; OK to call getters/setters.

FF_API_STATUS_NOT_INITIALIZED 

Initialization not started; please call the Hello() function.

FF_API_STATUS_INITIALIZING_PLEASE_WAIT 

Hello() has been called; now waiting for initialization to complete.

Definition at line 484 of file STFF-Types.h.

#include <STFF-Types.h>

Auto Gain setting options.

This is a type definition for an enumeration specifying an Auto Gain setting. Two settings are provided: Manual Gain and Auto Gain. This enumeration resides in the global namespace.

See also
STFF::STFishFinder::SetAutoGainSetting()
STFF::STFishFinder::GetAutoGainSetting()
STFF::valid(FF_AutoGainSetting_t)
Enumerator
FF_AUTO_GAIN_SETTING_MANUAL 

Gain setting is fixed and specified by calling SetGain.

FF_AUTO_GAIN_SETTING_AUTO 

Gain setting is adjusted automatically to maximize the visible target-to-clutter ratio.

Definition at line 380 of file STFF-Types.h.

#include <STFF-Types.h>

Auto Range setting options.

This is a type definition for an enumeration specifying an Auto Range setting. Three settings are provided: Manual Range, Auto Range, and Auto Shift. This enumeration resides in the global namespace.

See also
STFF::STFishFinder::SetAutoRangeSetting()
STFF::STFishFinder::GetAutoRangeSetting()
STFF::valid(FF_AutoRangeSetting_t)
Enumerator
FF_AUTO_RANGE_SETTING_MANUAL 

The shallow and deep range limits are set manually, using function STFishFinder::SetRange().

FF_AUTO_RANGE_SETTING_AUTO_RANGE 

The shallow range limit is fixed at 0, and the deep range limit is adjusted automatically to keep the seabed visible.

FF_AUTO_RANGE_SETTING_AUTO_SHIFT 

The delta between the shallow and deep range limits is fixed, and they are adjusted automatically in tandem to keep the seabed visible.

Definition at line 359 of file STFF-Types.h.

#include <STFF-Types.h>

Control Command options.

This is a type definition for an enumeration specifying valid commands for use with the API member function STFF::STFishFinder::Control(). This enumeration resides in the global namespace.

Note
  1. The values in this enumeration apply to the first parameter (command) in the call to STFF::STFishFinder::Control().
  2. At present only one value is supported: FF_CONTROL_COMMAND_ENABLE_BLACK_BOX_MESSAGES.
See also
STFF::STFishFinder::Control()
STFF::valid(FF_ControlCommand_t)
FF_ControlEnableBlackBoxMsg_t
Enumerator
FF_CONTROL_COMMAND_ENABLE_BLACK_BOX_MESSAGES 

Command to instruct the black box to enable or disable transmission of certain data messages.

Definition at line 257 of file STFF-Types.h.

#include <STFF-Types.h>

Control command parameter options for use with the FF_CONTROL_COMMAND_ENABLE_BLACK_BOX_MESSAGES option when calling STFF::STFishFinder::Control().

This is a type definition for an enumeration specifying valid mask values that are each used to enable periodic transmission by the black box of a specific data message. These apply only when calling STFF::STFishFinder::Control() with the FF_CONTROL_COMMAND_ENABLE_BLACK_BOX_MESSAGES value in the first parameter. The selected values in this enumeration are to be logically ORed together and provided in the second parameter (pParam) in the call to STFF::STFishFinder::Control(). Mask values that are omitted will result in the corresponding data message becoming disabled.

Remarks
In many systems, it is anticipated that all messages will be enabled. In this case, the FF_ENABLE_ALL_MESSAGES value may be used.
See also
STFF::STFishFinder::Control()
FF_ControlCommand_t
Enumerator
FF_ENABLE_MESSAGE_DEPTH 

Enable periodic transmission of Depth data message.

FF_ENABLE_MESSAGE_SPEED 

Enable periodic transmission of Speed data message.

FF_ENABLE_MESSAGE_TEMPERATURE 

Enable periodic transmission of Temperature data message.

FF_ENABLE_MESSAGE_BATTERY_VOLTAGE 

Enable periodic transmission of Battery Voltage data message.

FF_ENABLE_MESSAGE_IMAGE 

Enable periodic transmission of Image data message.

FF_ENABLE_MESSAGE_FISH 

Enable transmission of Fish data message on detection of possible fish target.

FF_ENABLE_MESSAGE_DEPTH_ALARM 

Enable transmission of Depth Alarm state message on every state change.

FF_ENABLE_ALL_MESSAGES 

Enable transmission of all messages.

Definition at line 288 of file STFF-Types.h.

#include <STFF-Types.h>

Data Status options.

This is a type definition for an enumeration specifying the status of a data item reported by an API data getter member function. This enumeration resides in the global namespace.

Enumerator
FF_DATA_STATUS_INVALID 

The associated data item is not valid, and should not be relied upon.

FF_DATA_STATUS_VALID 

The associated data item is valid and usable.

FF_DATA_STATUS_SIMULATED 

The associated data item is simulated. If displayed to the user, it must be identified as being a simulation.

FF_DATA_STATUS_PLAYBACK_VALID 

The associated data item was generated during a replay of a previously recorded session, and when originally recorded, was valid data. It does not represent current data.

Definition at line 231 of file STFF-Types.h.

#include <STFF-Types.h>

Data Type options.

This is a type definition for an enumeration specifying a Data Type, in reference to data messages transmitted from a black box fish finder. This enumeration resides in the global namespace.

See also
STFF::valid(FF_DataType_t)
Enumerator
FF_DATA_TYPE_DEPTH 

Specifies the Depth data type.

FF_DATA_TYPE_SPEED 

Specifies the Speed data type.

FF_DATA_TYPE_TEMPERATURE 

Specifies the Temperature data type.

FF_DATA_TYPE_BATTERY_VOLTAGE 

Specifies the Battery Voltage data type.

FF_DATA_TYPE_IMAGE 

Specifies the Fish Finder Image data type.

FF_DATA_TYPE_FISH 

Specifies the Fish data type.

FF_DATA_TYPE_DEPTH_ALARM 

Specifies the Depth Alarm data type.

Definition at line 210 of file STFF-Types.h.

#include <STFF-Types.h>

Depth Alarm State options.

This is a type definition for an enumeration specifying a Depth Alarm State (disabled, normal, active, or silenced). This enumeration resides in the global namespace.

See also
STFF::STFishFinder::GetDepthAlarmState()
STFF::STFishFinder::SilenceDepthAlarm()
STFF::valid(FF_DepthAlarmState_t)
STFF::STFishFinder::Callback_DepthAlarmStateChange_t
Enumerator
FF_DEPTH_ALARM_STATE_DISABLED 

Specifies a depth alarm state of Disabled (depth alarm is disabled)

FF_DEPTH_ALARM_STATE_NORMAL 

Specifies a depth alarm state of Normal (depth alarm is enabled, but an alarm condition is not present)

FF_DEPTH_ALARM_STATE_ACTIVE 

Specifies a depth alarm state of Active (depth alarm is enabled, an alarm condition is present, and alarm is sounding)

FF_DEPTH_ALARM_STATE_SILENCED 

Specifies a depth alarm state of Silenced (depth alarm is enabled, an alarm condition is present, but alarm has been temporarily silenced)

Definition at line 444 of file STFF-Types.h.

#include <STFF-Types.h>

Depth Alarm Type selection.

This is a type definition for an enumeration specifying a Depth Alarm Type (shallow alarm or deep alarm). This enumeration resides in the global namespace.

See also
STFF::STFishFinder::GetDepthAlarmSetting()
STFF::STFishFinder::SetDepthAlarmSetting()
STFF::valid(FF_DepthAlarmType_t)
Enumerator
FF_DEPTH_ALARM_TYPE_SHALLOW 

Specifies the Shallow depth alarm type.

FF_DEPTH_ALARM_TYPE_DEEP 

Specifies the Deep depth alarm type.

Definition at line 423 of file STFF-Types.h.

#include <STFF-Types.h>

Depth Units selection.

This is a type definition for an enumeration specifying distance units (feet, meters, or fathoms) used with an associated depth value. This enumeration resides in the global namespace.

See also
STFF::ConvertDepth()
STFF::valid(FF_DepthUnits_t)
Enumerator
FF_DEPTH_UNITS_FEET 

Depth units are Feet.

FF_DEPTH_UNITS_METERS 

Depth units are Meters.

FF_DEPTH_UNITS_FATHOMS 

Depth units are Fathoms.

Definition at line 96 of file STFF-Types.h.

enum FF_Error_t

#include <STFF-Types.h>

Error codes.

This is a type definition for an enumeration specifying an Error Code returned by a STFF::STFishFinder class member function. This enumeration resides in the global namespace.

Enumerator
FF_ERR_INVALID_FREQUENCY 

Frequency argument provided was not valid.

FF_ERR_INVALID_POINTER 

A provided pointer argument was not valid.

FF_ERR_ARGUMENT_OUT_OF_RANGE 

The value of an argument was not within the allowed range.

FF_ERR_BAD_DATABASE 

The API encountered an internal error.

FF_ERR_API_NOT_INITIALIZED 

The requested method may not be called before initializing the API.

FF_ERR_API_ALREADY_INITIALIZED 

The Hello() function was already called for the present connection.

FF_ERR_EXCEPTION_OCCURRED 

An exception was thrown and caught within the API.

FF_ERR_CANT_CHANGE_CALLBACKS 

Function STFF::STFishFinder::SetCallbacks() may not be called if any STFishFinder objects exist.

FF_ERR_NO_ERROR 

Successful completion of the method.

Definition at line 50 of file STFF-Types.h.

#include <STFF-Types.h>

Sonar Frequency options.

This is a type definition for an enumeration specifying a sonar frequency context. Two frequencies are supported: 50 kHz and 200 kHz. This enumeration resides in the global namespace.

See also
STFF::valid(FF_Frequency_t)
Enumerator
FF_INVALID_FREQUENCY 

Invalid frequency or frequency not specified.

FF_FREQUENCY_200_KHZ 

Specifies a 200 kilohertz sonar context.

FF_FREQUENCY_50_KHZ 

Specifies a 50 kilohertz sonar context.

Definition at line 77 of file STFF-Types.h.

#include <STFF-Types.h>

Sonar Frequency Mode options.

This is a type definition for an enumeration specifying sonar frequency(ies) to be used for the image data provided by the sounder electronics. Three options are provided: 200 kHz, 50 kHz, and Dual mode. This enumeration resides in the global namespace.

See also
STFF::STFishFinder::SetFrequencyMode()
STFF::STFishFinder::GetFrequencyMode()
STFF::valid(FF_FrequencyMode_t)
Enumerator
FF_FREQUENCY_MODE_200_KHZ 

Specifies that the provided sonar image data is to be at the 200 kHz frequency.

FF_FREQUENCY_MODE_50_KHZ 

Specifies that the provided sonar image data is to be at the 50 kHz frequency.

FF_FREQUENCY_MODE_DUAL 

Specifies that the provided sonar image data is to alternate between the 200 kHz and 50 kHz frequencies.

Definition at line 314 of file STFF-Types.h.

#include <STFF-Types.h>

Setting Status options.

This is a type definition for an enumeration specifying the status of a setting item reported by an API setting getter member function. This enumeration resides in the global namespace.

Enumerator
FF_SETTING_STATUS_INVALID 

The associated setting is not valid, and should not be used.

FF_SETTING_STATUS_PENDING 

The associated setting has been sent to the black box, but a confirmation has not yet been received.

FF_SETTING_STATUS_VALID 

The associated setting is valid.

Definition at line 193 of file STFF-Types.h.

#include <STFF-Types.h>

Setting Type options.

This is a type definition for an enumeration specifying a Setting type or a Master Setting type. This enumeration resides in the global namespace.

See also
STFF::valid(FF_SettingType_t)
STFF::STFishFinder::Hello()
Setters
Enumerator
FF_SETTING_TYPE_API_READY 

Not a setting type per se, but is provided to the onSettingChanged callback when the API is ready to service calls to setter and getter functions.

FF_SETTING_TYPE_CONTROL 

Specifies the setting type for Control messages.

See also
STFF::STFishFinder::Control()
FF_SETTING_TYPE_BIT_DEPTH 

Specifies the setting type for Bit Depth.

See also
STFF::STFishFinder::SetBitDepth()
FF_SETTING_TYPE_NUM_INPUT_SAMPLES 

Specifies the setting type for Number of Input Samples.

See also
STFF::STFishFinder::SetNumInputSamples()
FF_SETTING_TYPE_FREQUENCY_MODE 

Specifies the setting type for Frequency Mode.

See also
STFF::STFishFinder::SetFrequencyMode()
FF_SETTING_TYPE_DEPTH_UNITS 

Specifies the setting type for Depth Units.

See also
STFF::STFishFinder::SetDepthUnits()
FF_SETTING_TYPE_AUTO_GAIN_SETTING 

Specifies the setting type for Auto Gain.

See also
STFF::STFishFinder::SetAutoGainSetting()
FF_SETTING_TYPE_WATER_FILTER_SETTING 

Specifies the setting type for Water Filter.

See also
STFF::STFishFinder::SetWaterFilterSetting()
FF_SETTING_TYPE_AUTO_RANGE_SETTING 

Specifies the setting type for Auto Range.

See also
STFF::STFishFinder::SetAutoRangeSetting()
FF_SETTING_TYPE_RANGE 

Specifies the setting type for Range.

See also
STFF::STFishFinder::SetRange()
FF_SETTING_TYPE_GAIN 

Specifies the setting type for Gain.

See also
STFF::STFishFinder::SetGain()
FF_SETTING_TYPE_GAIN_OFFSET 

Specifies the setting type for Gain Offset.

See also
STFF::STFishFinder::SetGainOffset()
FF_SETTING_TYPE_GAIN_COLOR_OFFSETS 

Specifies the setting type for Gain Color Offsets.

See also
STFF::STFishFinder::SetGainColorOffsets()
FF_SETTING_TYPE_FSTC 

Specifies the setting type for FSTC (Fishfinder Sensitivity Time Constant).

See also
STFF::STFishFinder::SetFstc()
FF_SETTING_TYPE_FISH_ID_SETTING 

Specifies the setting type for Fish ID.

See also
STFF::STFishFinder::SetFishIdSetting()
FF_SETTING_TYPE_FISH_ALARM_SETTING 

Specifies the setting type for Fish Alarm.

See also
STFF::STFishFinder::SetFishAlarmSetting()
FF_SETTING_TYPE_MASTER_DEPTH_ALARM_SETTING 

Specifies the master setting type for Depth Alarm.

See also
STFF::STFishFinder::SetDepthAlarmSetting()
FF_SETTING_TYPE_MASTER_SPEED_PPNM 

Specifies the master setting type for Speed Pulses Per Nautical Mile.

See also
STFF::STFishFinder::SetSpeedPpnm()
FF_SETTING_TYPE_MASTER_TEMPERATURE_OFFSET 

Specifies the master setting type for Temperature Offset.

See also
STFF::STFishFinder::SetTemperatureOffset()
FF_SETTING_TYPE_MASTER_DSTC 

Specifies the master setting type for DSTC (Depth Sensitivity Time Constant).

See also
STFF::STFishFinder::SetDstc()
FF_SETTING_TYPE_MASTER_WATER_TYPE 

Specifies the master setting type for Water Type (for establishing speed of sound constant).

See also
STFF::STFishFinder::SetWaterType()

Definition at line 158 of file STFF-Types.h.

#include <STFF-Types.h>

Speed Units selection.

This is a type definition for an enumeration specifying speed units (knots, miles per hour, or kilometers per hour) used with an associated speed-through-water value. This enumeration resides in the global namespace.

See also
STFF::ConvertSpeed()
STFF::valid(FF_SpeedUnits_t)
Enumerator
FF_SPEED_UNITS_KNOTS 

Speed units are knots (nautical miles per hour)

FF_SPEED_UNITS_MPH 

Speed units are statute miles per hour.

FF_SPEED_UNITS_KPH 

Speed units are kilometers per hour.

Definition at line 117 of file STFF-Types.h.

#include <STFF-Types.h>

Temperature Units selection.

This is a type definition for an enumeration specifying temperature units (degrees Celsius or degrees Fahrenheit) used with an associated temperature value. This enumeration resides in the global namespace.

See also
STFF::ConvertTemperature()
STFF::valid(FF_TemperatureUnits_t)
Enumerator
FF_TEMPERATURE_UNITS_CELSIUS 

Temperature units are degrees Celsius.

FF_TEMPERATURE_UNITS_FAHRENHEIT 

Temperature units are degrees Fahrenheit.

Definition at line 138 of file STFF-Types.h.