These are type definitions for simple structs in the global namespace. More...

Classes
struct	FF_DepthData_t
	Depth Data structure. More...

struct	FF_BatteryVoltageData_t
	Battery Voltage Data structure. More...

struct	FF_FishData_t
	Fish Data structure. More...

struct	FF_RangeSetting_t
	Range Setting structure. More...

struct	FF_FstcSetting_t
	FSTC Setting structure. More...

struct	FF_DstcSetting_t
	DSTC Setting structure. More...

struct	FF_FishIdSetting_t
	Fish ID Setting structure. More...

struct	FF_TemperatureData_t
	Temperature Data structure. More...

struct	FF_SpeedData_t
	Speed Data structure. More...

Detailed Description

These are type definitions for simple structs 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.

Class Documentation

struct FF_DepthData_t

Depth Data structure.

This is a type definition for a simple struct containing a depth reading. This struct resides in the global namespace.

The depth member of the struct is in hundredths of a unit (feet, meters, or fathoms, depending on the value of the units member). For example, a value of 730 would represent 7.30 feet (or meters, or fathoms).

See also: STFF::STFishFinder::GetDepth()

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

Class Members
uint32_t	depth	Depth value, in hundredths of the specified units.
FF_DataStatus_t	status	Status of the provided depth value (valid/invalid, simulated, or log playback)
FF_DepthUnits_t	units	Units (feet, meters, or fathoms) for the provided depth value.

struct FF_BatteryVoltageData_t

Battery Voltage Data structure.

This is a type definition for a simple struct containing a battery voltage reading. This struct resides in the global namespace.

The voltage member of the struct is in hundredths of a volt. For example, a value of 1250 would represent 12.50 volts.

See also: STFF::STFishFinder::GetBatteryVoltage()

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

Class Members
FF_DataStatus_t	status	Status of the provided battery voltage value (valid/invalid, simulated, or log playback)
uint16_t	voltage	Voltage of the battery used to power the black box fish finder, in hundredths of a volt.

struct FF_FishData_t

Fish Data structure.

This is a type definition for a simple struct containing details regarding a detected "possible fish." This struct resides in the global namespace.

When the Fish ID feature is enabled, the black box will perform heuristics to attempt to detect fish targets in the received signal. When the black box decides that a given monitored structure meets the qualifications required to be declared a possible fish target, it sends the detailed data regarding the possible fish target to the display device using this struct.

Todo:: The present contents of the FF_FishData_t struct are only tentative; these need to be firmed up.

See also: STFF::STFishFinder::SetFishIdSetting(); STFF::STFishFinder::GetFishIdSetting(); FF_FishIdSetting_t

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

Class Members
uint32_t	depth	Depth of target, in hundredths of the specified units.
FF_Frequency_t	frequency	Frequency context in which the target was detected.
uint16_t	intensity	Relative intensity of target.
uint16_t	size	Relative size of target.
FF_DataStatus_t	status	Status of the data in this struct (valid/invalid, simulated, or log playback)
FF_DepthUnits_t	units	Units (feet, meters, or fathoms) for the provided depth of the target.

struct FF_RangeSetting_t

Range Setting structure.

This is a type definition for a simple struct containing a fish finder range setting. This struct resides in the global namespace.

The rangeShallow and rangeDeep members of the struct are in hundredths of a unit (feet, meters, or fathoms, depending on the value of the units member). For example, a value of 2000 would represent 20.00 feet (or meters, or fathoms).

See also: STFF::STFishFinder::SetRange(); STFF::STFishFinder::GetRange()

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

Class Members
uint32_t	rangeDeep	Depth corresponding to the last sample in the image buffer, in hundredths of the specified units.
uint32_t	rangeShallow	Depth corresponding to the first sample in the image buffer, in hundredths of the specified units.
FF_DepthUnits_t	units	Units (feet, meters, or fathoms) for the provided rangeShallow and rangeDeep values.

struct FF_FstcSetting_t

FSTC Setting structure.

This is a type definition for a simple struct containing a FSTC (Fishfinder Sensitivity Time Constant) setting. This struct resides in the global namespace.

See also: STFF::STFishFinder::SetFSTC(); STFF::STFishFinder::GetFstc()

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

Class Members
uint16_t	fstd	Depth, in tenths of a meter, at the end of the FSTC ramp.
uint16_t	fsts	Magnitude of gain attenuation at the start of the FSTC ramp at the surface of the transducer.

struct FF_DstcSetting_t

DSTC Setting structure.

This is a type definition for a simple struct containing a DSTC (Depth Sensitivity Time Constant) setting. This struct resides in the global namespace.

See also: STFF::STFishFinder::SetDSTC(); STFF::STFishFinder::GetDstc()

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

Class Members
uint16_t	dstd	Depth, in tenths of a meter, at the end of the DSTC ramp.
uint16_t	dsts	Magnitude of gain attenuation at the start of the DSTC ramp at the surface of the transducer.

struct FF_FishIdSetting_t

Fish ID Setting structure.

This is a type definition for a simple struct containing a Fish ID setting. This struct resides in the global namespace.

Todo:: The present contents of the FF_FishIdSetting_t struct are only tentative; these need to be firmed up.

See also: STFF::STFishFinder::SetFishIdSetting(); STFF::STFishFinder::GetFishIdSetting(); FF_FishData_t

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

Class Members
bool	enabled
uint16_t	threshold

struct FF_TemperatureData_t

Temperature Data structure.

This is a type definition for a simple struct containing a water temperature reading. This struct resides in the global namespace.

The temperature member of the struct is in hundredths of a degree (Celsius or Fahrenheit, depending on the value of the units member). For example, a value of 2510 would represent 25.10 degrees.

See also: STFF::STFishFinder::GetTemperature()

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

Class Members
FF_DataStatus_t	status	Status of the provided temperature value (valid/invalid, simulated, or log playback)
int16_t	temperature	Temperature value, in hundredths of the specified units.
FF_TemperatureUnits_t	units	Units (degrees Celsius or degrees Fahrenheit) for the provided temperature value.

struct FF_SpeedData_t

Speed Data structure.

This is a type definition for a simple struct containing a speed-through-water reading. This struct resides in the global namespace.

The speed member of the struct is in hundredths of a unit (knots, mph, or kph, depending on the value of the units member). For example, a value of 1020 would represent 10.20 knots (or mph, or kph).

See also: STFF::STFishFinder::GetSpeed()

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

Class Members
uint16_t	speed	Speed value, in hundredths of the specified units.
FF_DataStatus_t	status	Status of the provided speed value (valid/invalid, simulated, or log playback)
FF_SpeedUnits_t	units	Units (knots, mph, or kph) for the provided speed value.

Classes

Detailed Description

Class Documentation