Constructors and destructors for the STFishFinder class. More...

Functions
static STFishFinder *	STFF::STFishFinder::CreateFishFinder (FF_Error_t *pError)
	Use this function to create an STFishFinder API object once a connection (or session) has been established with a compatible black box fish finder. More...

static STFishFinder *	STFF::STFishFinder::CreateSimulatedFishFinder (FF_Error_t *pError)
	Use this function to create an STFishFinder API object that provides simulated data for demonstration purposes in the absence of an actual black box fish finder. More...

static STFishFinder *	STFF::STFishFinder::CreateFishFinderForPlayback (const Replay pPlaybackData, FF_Error_t pError)
	Use this function to create an STFishFinder API object for the purpose of playing back a previously recorded session. More...

	STFF::STFishFinder::~STFishFinder ()
	This is the STFishFinder class destructor. More...

Detailed Description

Constructors and destructors for the STFishFinder class.

Function Documentation

STFF::STFishFinder::~STFishFinder ( )

#include <STFF-FishFinder.h>

This is the STFishFinder class destructor.

The ~STFishFinder() destructor should be called when

the connection to the associated black box fish finder has been lost (or the session has closed), or
an STFishFinder object created for use in Simulator Mode or Playback Mode is no longer needed.

Returns: (not applicable)

STFishFinder * STFF::STFishFinder::CreateFishFinder ( FF_Error_t * pError )

static

#include <STFF-FishFinder.h>

Use this function to create an STFishFinder API object once a connection (or session) has been established with a compatible black box fish finder.

This function is a wrapper for the STFishFinder() class constructor. The actual STFishFinder() constructor is a private member of the STFishFinder class. The present member function insulates the calling environment from any exceptions that might be thrown when constructing the STFishFinder object. If an exception occurs, this function catches the exception and provides an appropriate error code to the caller.

Conceptually, if a system is otherwise designed to accommodate multiple black box fish finders, this function should be called once for each connected black box.

Parameters

[out]

pError

pointer to a location that will be written with an FF_Error_t error code indicating whether the STFishFinder object was successfully created. If the pError parameter is a null pointer, then no error code will be stored. Specific error codes include:

FF_ERR_NO_ERROR : the STFishFinder object was created successfully
FF_ERR_EXCEPTION_OCCURRED : an exception occurred when attempting to construct the STFishFinder object

Returns: STFishFinder* pointer to a new STFishFinder object, or null if an error occurs

Note: When the returned STFishFinder object is no longer needed, use the ~STFishFinder() destructor to deallocate the memory used by the object.
For example:
using namespace STFF;

STFishFinder* pFF;

FF_Error_t error;

pFF = CreateFishFinder (&error);

if (error == FF_ERR_NO_ERROR && pFF) {

pFF->Hello();

// (Use the created STFishFinder object)

// When the object is eventually no longer needed:

delete pFF;

}

See also: STFishFinder* CreateSimulatedFishFinder; STFishFinder* CreateFishFinderForPlayback; ~STFishFinder()

STFishFinder * STFF::STFishFinder::CreateFishFinderForPlayback	(	const Replay *	pPlaybackData,
		FF_Error_t *	pError
	)

static

#include <STFF-FishFinder.h>

Use this function to create an STFishFinder API object for the purpose of playing back a previously recorded session.

This function is a wrapper for a STFishFinder() class constructor. The actual STFishFinder() constructor is a private member of the STFishFinder class. The present member function insulates the calling environment from any exceptions that might be thrown when constructing the STFishFinder object. If an exception occurs, this function catches the exception and provides an appropriate error code to the caller.

Parameters

[in]	pPlaybackData	pointer to Replay object containing the session data to be played back. If this parameter is a null pointer, then no STFishFinder object will be created, the `pError` location will be written with FF_ERR_INVALID_POINTER, and the function will return `null`.
[out]	pError	pointer to a location that will be written with an FF_Error_t error code indicating whether the STFishFinder object was successfully created. If the `pError` parameter is a null pointer, then no error code will be stored. Specific error codes include: FF_ERR_NO_ERROR : the STFishFinder object was created successfully FF_ERR_EXCEPTION_OCCURRED : an exception occurred when attempting to construct the STFishFinder object FF_ERR_INVALID_POINTER : the `pPlaybackData` parameter was a null pointer

Returns: STFishFinder* pointer to a new STFishFinder object, or null if an error occurs

Note: When the returned STFishFinder object is no longer needed, use the ~STFishFinder() destructor to deallocate the memory used by the object.
For example:
using namespace STFF;

STFishFinder* pFF;

FF_Error_t error;

const Replay* pPlaybackObject = &PreviouslySavedReplayObject;

pFF = CreateFishFinderForPlayback (pPlaybackObject, &error);

if (error == FF_ERR_NO_ERROR && pFF) {

pFF->Hello();

// (Use the created STFishFinder object)

// When the object is eventually no longer needed:

delete pFF;

}

See also: STFishFinder* CreateFishFinder; STFishFinder* CreateSimulatedFishFinder

STFishFinder * STFF::STFishFinder::CreateSimulatedFishFinder ( FF_Error_t * pError )

static

#include <STFF-FishFinder.h>

Use this function to create an STFishFinder API object that provides simulated data for demonstration purposes in the absence of an actual black box fish finder.

This function is a wrapper for a STFishFinder() class constructor. The actual STFishFinder() constructor is a private member of the STFishFinder class. The present member function insulates the calling environment from any exceptions that might be thrown when constructing the STFishFinder object. If an exception occurs, this function catches the exception and provides an appropriate error code to the caller.

Parameters

[out]

pError

pointer to a location that will be written with an FF_Error_t error code indicating whether the STFishFinder object was successfully created. If the pError parameter is a null pointer, then no error code will be stored. Specific error codes include:

FF_ERR_NO_ERROR : the STFishFinder object was created successfully
FF_ERR_EXCEPTION_OCCURRED : an exception occurred when attempting to construct the STFishFinder object

Returns: STFishFinder* pointer to a new STFishFinder object, or null if an error occurs

Note: When the returned STFishFinder object is no longer needed, use the ~STFishFinder() destructor to deallocate the memory used by the object.
For example:
using namespace STFF;

STFishFinder* pFF;

FF_Error_t error;

pFF = CreateSimulatedFishFinder (&error);

if (error == FF_ERR_NO_ERROR && pFF) {

pFF->Hello();

// (Use the created STFishFinder object)

// When the object is eventually no longer needed:

delete pFF;

}

See also: STFishFinder* CreateFishFinder; STFishFinder* CreateFishFinderForPlayback

Functions

Detailed Description

Function Documentation