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... | |
These are type definitions for enumerations in the global namespace.
enum FF_ApiStatus_t |
#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.
Definition at line 484 of file STFF-Types.h.
enum FF_AutoGainSetting_t |
#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.
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.
Definition at line 359 of file STFF-Types.h.
enum FF_ControlCommand_t |
#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.
command
) in the call to STFF::STFishFinder::Control().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.
Definition at line 288 of file STFF-Types.h.
enum FF_DataStatus_t |
#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.
Definition at line 231 of file STFF-Types.h.
enum FF_DataType_t |
#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.
Definition at line 210 of file STFF-Types.h.
enum FF_DepthAlarmState_t |
#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.
Definition at line 444 of file STFF-Types.h.
enum FF_DepthAlarmType_t |
#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.
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.
enum FF_DepthUnits_t |
#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.
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.
enum FF_Frequency_t |
#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.
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.
enum FF_FrequencyMode_t |
#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.
Definition at line 314 of file STFF-Types.h.
enum FF_SettingStatus_t |
#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.
Definition at line 193 of file STFF-Types.h.
enum FF_SettingType_t |
#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.
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.
|
FF_SETTING_TYPE_BIT_DEPTH |
Specifies the setting type for Bit Depth.
|
FF_SETTING_TYPE_NUM_INPUT_SAMPLES |
Specifies the setting type for Number of Input Samples. |
FF_SETTING_TYPE_FREQUENCY_MODE |
Specifies the setting type for Frequency Mode. |
FF_SETTING_TYPE_DEPTH_UNITS |
Specifies the setting type for Depth Units.
|
FF_SETTING_TYPE_AUTO_GAIN_SETTING |
Specifies the setting type for Auto Gain. |
FF_SETTING_TYPE_WATER_FILTER_SETTING |
Specifies the setting type for Water Filter.
|
FF_SETTING_TYPE_AUTO_RANGE_SETTING |
Specifies the setting type for Auto Range. |
FF_SETTING_TYPE_RANGE |
Specifies the setting type for Range.
|
FF_SETTING_TYPE_GAIN |
Specifies the setting type for Gain.
|
FF_SETTING_TYPE_GAIN_OFFSET |
Specifies the setting type for Gain Offset. |
FF_SETTING_TYPE_GAIN_COLOR_OFFSETS |
Specifies the setting type for Gain Color Offsets. |
FF_SETTING_TYPE_FSTC |
Specifies the setting type for FSTC (Fishfinder Sensitivity Time Constant).
|
FF_SETTING_TYPE_FISH_ID_SETTING |
Specifies the setting type for Fish ID. |
FF_SETTING_TYPE_FISH_ALARM_SETTING |
Specifies the setting type for Fish Alarm.
|
FF_SETTING_TYPE_MASTER_DEPTH_ALARM_SETTING |
Specifies the master setting type for Depth Alarm.
|
FF_SETTING_TYPE_MASTER_SPEED_PPNM |
Specifies the master setting type for Speed Pulses Per Nautical Mile.
|
FF_SETTING_TYPE_MASTER_TEMPERATURE_OFFSET |
Specifies the master setting type for Temperature Offset. |
FF_SETTING_TYPE_MASTER_DSTC |
Specifies the master setting type for DSTC (Depth Sensitivity Time Constant).
|
FF_SETTING_TYPE_MASTER_WATER_TYPE |
Specifies the master setting type for Water Type (for establishing speed of sound constant).
|
Definition at line 158 of file STFF-Types.h.
enum FF_SpeedUnits_t |
#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.
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.
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.