Functions that provide a quick test to verify that an enumeration value falls within the range of valid values for the given type. More...

Functions
bool	STFF::valid (FF_DepthUnits_t units)
	Test that a value is valid for a variable of type FF_DepthUnits_t. More...

bool	STFF::valid (FF_Frequency_t frequency)
	Test that a value is valid for a variable of type FF_Frequency_t. More...

bool	STFF::valid (FF_SpeedUnits_t units)
	Test that a value is valid for a variable of type FF_SpeedUnits_t. More...

bool	STFF::valid (FF_TemperatureUnits_t units)
	Test that a value is valid for a variable of type FF_TemperatureUnits_t. More...

bool	STFF::valid (FF_SettingType_t settingType)
	Test that a value is valid for a variable of type FF_SettingType_t. More...

bool	STFF::valid (FF_DataType_t dataType)
	Test that a value is valid for a variable of type FF_DataType_t. More...

bool	STFF::valid (FF_ControlCommand_t controlCommand)
	Test that a value is valid for a variable of type FF_ControlCommand_t. More...

bool	STFF::valid (FF_FrequencyMode_t frequencyMode)
	Test that a value is valid for a variable of type FF_FrequencyMode_t. More...

bool	STFF::valid (FF_AutoRangeSetting_t autoRangeSetting)
	Test that a value is valid for a variable of type FF_AutoRangeSetting_t. More...

bool	STFF::valid (FF_AutoGainSetting_t autoGainSetting)
	Test that a value is valid for a variable of type FF_AutoGainSetting_t. More...

bool	STFF::valid (FF_DepthAlarmType_t depthAlarmType)
	Test that a value is valid for a variable of type FF_DepthAlarmType_t. More...

bool	STFF::valid (FF_DepthAlarmState_t depthAlarmState)
	Test that a value is valid for a variable of type FF_DepthAlarmState_t. More...

bool	STFF::valid (FF_FishAlarmSetting_t fishAlarmSetting)
	Test that a value is valid for a variable of type ::FF_FishAlarmSetting_t. More...

bool	STFF::valid (FF_ApiStatus_t apiStatus)
	Test that a value is valid for a variable of type FF_ApiStatus_t. More...

Detailed Description

Functions that provide a quick test to verify that an enumeration value falls within the range of valid values for the given type.

These are overloaded functions, all having the same name valid, but each with a distinct argument list.

These are non-member functions that reside in the STFF namespace.

Function Documentation

STFF::valid ( FF_Frequency_t frequency )

inline

#include <STFF-Utility.h>

Test that a value is valid for a variable of type FF_Frequency_t.

Parameters

[in] frequency the value to be tested

Return values

true	if the value of the `frequency` parameter is valid for a variable of type FF_Frequency_t
false	otherwise

Remarks: This is an overloaded function that differs from other valid() functions in the argument(s) it accepts.

See also: FF_Frequency_t

Definition at line 223 of file STFF-Utility.h.

STFF::valid ( FF_DepthUnits_t units )

inline

#include <STFF-Utility.h>

Test that a value is valid for a variable of type FF_DepthUnits_t.

Return values

false otherwise

Remarks: This is an overloaded function that differs from other valid() functions in the argument(s) it accepts.

See also: FF_DepthUnits_t

Parameters

[in] units the value to be tested

Return values

true	if the value of the `units` parameter is valid for a variable of type FF_DepthUnits_t

Definition at line 252 of file STFF-Utility.h.

STFF::valid ( FF_SpeedUnits_t units )

inline

#include <STFF-Utility.h>

Test that a value is valid for a variable of type FF_SpeedUnits_t.

Parameters

[in] units the value to be tested

Return values

true	if the value of the `units` parameter is valid for a variable of type FF_SpeedUnits_t
false	otherwise

Remarks: This is an overloaded function that differs from other valid() functions in the argument(s) it accepts.

See also: FF_SpeedUnits_t

Definition at line 281 of file STFF-Utility.h.

STFF::valid ( FF_TemperatureUnits_t units )

inline

#include <STFF-Utility.h>

Test that a value is valid for a variable of type FF_TemperatureUnits_t.

Parameters

[in] units the value to be tested

Return values

true	if the value of the `units` parameter is valid for a variable of type FF_TemperatureUnits_t
false	otherwise

Remarks: This is an overloaded function that differs from other valid() functions in the argument(s) it accepts.

See also: FF_TemperatureUnits_t

Definition at line 311 of file STFF-Utility.h.

STFF::valid ( FF_SettingType_t settingType )

inline

#include <STFF-Utility.h>

Test that a value is valid for a variable of type FF_SettingType_t.

Parameters

[in] settingType the value to be tested

Return values

true	if the value of the `settingType` parameter is valid for a variable of type FF_SettingType_t
false	otherwise

Remarks: This is an overloaded function that differs from other valid() functions in the argument(s) it accepts.

See also: FF_SettingType_t

Definition at line 340 of file STFF-Utility.h.

STFF::valid ( FF_DataType_t dataType )

inline

#include <STFF-Utility.h>

Test that a value is valid for a variable of type FF_DataType_t.

Parameters

[in] dataType the value to be tested

Return values

true	if the value of the `dataType` parameter is valid for a variable of type FF_DataType_t
false	otherwise

Remarks: This is an overloaded function that differs from other valid() functions in the argument(s) it accepts.

See also: FF_DataType_t

Definition at line 369 of file STFF-Utility.h.

STFF::valid ( FF_ControlCommand_t controlCommand )

inline

#include <STFF-Utility.h>

Test that a value is valid for a variable of type FF_ControlCommand_t.

Parameters

[in] controlCommand the value to be tested

Return values

true	if the value of the `controlCommand` parameter is valid for a variable of type FF_ControlCommand_t
false	otherwise

Remarks: This is an overloaded function that differs from other valid() functions in the argument(s) it accepts.

See also: FF_ControlCommand_t

Definition at line 399 of file STFF-Utility.h.

STFF::valid ( FF_FrequencyMode_t frequencyMode )

inline

#include <STFF-Utility.h>

Test that a value is valid for a variable of type FF_FrequencyMode_t.

Parameters

[in] frequencyMode the value to be tested

Return values

true	if the value of the `frequencyMode` parameter is valid for a variable of type FF_FrequencyMode_t
false	otherwise

Remarks: This is an overloaded function that differs from other valid() functions in the argument(s) it accepts.

See also: FF_FrequencyMode_t

Definition at line 428 of file STFF-Utility.h.

STFF::valid ( FF_AutoRangeSetting_t autoRangeSetting )

inline

#include <STFF-Utility.h>

Test that a value is valid for a variable of type FF_AutoRangeSetting_t.

Parameters

[in] autoRangeSetting the value to be tested

Return values

true	if the value of the `autoRangeSetting` parameter is valid for a variable of type FF_AutoRangeSetting_t
false	otherwise

Remarks: This is an overloaded function that differs from other valid() functions in the argument(s) it accepts.

See also: FF_AutoRangeSetting_t

Definition at line 458 of file STFF-Utility.h.

STFF::valid ( FF_AutoGainSetting_t autoGainSetting )

inline

#include <STFF-Utility.h>

Test that a value is valid for a variable of type FF_AutoGainSetting_t.

Parameters

[in] autoGainSetting the value to be tested

Return values

true	if the value of the `autoGainSetting` parameter is valid for a variable of type FF_AutoGainSetting_t
false	otherwise

Remarks: This is an overloaded function that differs from other valid() functions in the argument(s) it accepts.

See also: FF_AutoGainSetting_t

Definition at line 488 of file STFF-Utility.h.

STFF::valid ( FF_DepthAlarmType_t depthAlarmType )

inline

#include <STFF-Utility.h>

Test that a value is valid for a variable of type FF_DepthAlarmType_t.

Parameters

[in] depthAlarmType the value to be tested

Return values

true	if the value of the `depthAlarmType` parameter is valid for a variable of type FF_DepthAlarmType_t
false	otherwise

Remarks: This is an overloaded function that differs from other valid() functions in the argument(s) it accepts.

See also: FF_DepthAlarmType_t

Definition at line 518 of file STFF-Utility.h.

STFF::valid ( FF_DepthAlarmState_t depthAlarmState )

inline

#include <STFF-Utility.h>

Test that a value is valid for a variable of type FF_DepthAlarmState_t.

Parameters

[in] depthAlarmState the value to be tested

Return values

true	if the value of the `depthAlarmState` parameter is valid for a variable of type FF_DepthAlarmState_t
false	otherwise

Remarks: This is an overloaded function that differs from other valid() functions in the argument(s) it accepts.

See also: FF_DepthAlarmState_t

Definition at line 548 of file STFF-Utility.h.

STFF::valid ( FF_FishAlarmSetting_t fishAlarmSetting )

inline

#include <STFF-Utility.h>

Test that a value is valid for a variable of type ::FF_FishAlarmSetting_t.

Parameters

[in] fishAlarmSetting the value to be tested

Return values

true	if the value of the `fishAlarmSetting` parameter is valid for a variable of type ::FF_FishAlarmSetting_t
false	otherwise

Remarks: This is an overloaded function that differs from other valid() functions in the argument(s) it accepts.

See also: ::FF_FishAlarmSetting_t

Definition at line 578 of file STFF-Utility.h.

STFF::valid ( FF_ApiStatus_t apiStatus )

inline

#include <STFF-Utility.h>

Test that a value is valid for a variable of type FF_ApiStatus_t.

Parameters

[in] apiStatus the value to be tested

Return values

true	if the value of the `apiStatus` parameter is valid for a variable of type FF_ApiStatus_t
false	otherwise

Remarks: This is an overloaded function that differs from other valid() functions in the argument(s) it accepts.

See also: FF_ApiStatus_t

Definition at line 607 of file STFF-Utility.h.