GammaSuitFunc Class Reference

This is the class used to calculate the suitability based on a Gamma function, usually used when calculating suitability curves for gillnet fleets. More...

#include <suitfunc.h>

Inheritance diagram for GammaSuitFunc:

Collaboration diagram for GammaSuitFunc:

Public Member Functions
	GammaSuitFunc ()
	This is the GammaSuitFunc constructor. More...
virtual	~GammaSuitFunc ()
	This is the default GammaSuitFunc destructor. More...
virtual int	usesPredLength ()
	This will return 1 if the suitability function is based on the predator length, 0 otherwise. More...
virtual int	usesPreyLength ()
	This will return 1 if the suitability function is based on the prey length, 0 otherwise. More...
virtual void	setPreyLength (double length)
	This will set the prey length. More...
virtual double	calculate ()
	This will return the suitability value that has been calculated. More...
Public Member Functions inherited from SuitFunc
	SuitFunc (const char *givenname)
	This is the default SuitFunc constructor. More...
virtual	~SuitFunc ()
	This is the default SuitFunc destructor. More...
const ModelVariableVector &	getConstants () const
	This function will return the value of the selection function parameters. More...
void	readConstants (CommentStream &infile, const TimeClass *const TimeInfo, Keeper *const keeper)
	This function will read the value of the suitability function parameters from file. More...
void	updateConstants (const TimeClass *const TimeInfo)
	This function will update the suitability function parameters. More...
int	didChange (const TimeClass *const TimeInfo)
	This function will check to see if the suitability function parameters have changed. More...
virtual void	setPredLength (double length)
	This will set the predator length. More...
int	numConstants ()
	This will return the number of constants used to calculate the suitability value. More...
Public Member Functions inherited from HasName
	HasName ()
	This is the default HasName constructor. More...
virtual	~HasName ()
	This is the default HasName destructor. More...
	HasName (const char *givenname)
	This is the HasName constructor for a specified name. More...
const char *	getName () const
	This will return a null terminated text string containing the name of the object. More...

Additional Inherited Members
Protected Attributes inherited from SuitFunc
ModelVariableVector	coeff
	This is the ModelVariableVector of suitability function constants. More...

Detailed Description

This is the class used to calculate the suitability based on a Gamma function, usually used when calculating suitability curves for gillnet fleets.

Constructor & Destructor Documentation

GammaSuitFunc()

GammaSuitFunc::GammaSuitFunc

(

)

This is the GammaSuitFunc constructor.

~GammaSuitFunc()

virtual GammaSuitFunc::~GammaSuitFunc ( )

inlinevirtual

This is the default GammaSuitFunc destructor.

Member Function Documentation

calculate()

double GammaSuitFunc::calculate ( )

virtual

This will return the suitability value that has been calculated.

Returns

value

Implements SuitFunc.

setPreyLength()

virtual void GammaSuitFunc::setPreyLength ( double  length )

inlinevirtual

This will set the prey length.

Parameters

length

is the prey length

Reimplemented from SuitFunc.

usesPredLength()

virtual int GammaSuitFunc::usesPredLength ( )

inlinevirtual

This will return 1 if the suitability function is based on the predator length, 0 otherwise.

Returns

0

Implements SuitFunc.

usesPreyLength()

virtual int GammaSuitFunc::usesPreyLength ( )

inlinevirtual

This will return 1 if the suitability function is based on the prey length, 0 otherwise.

Returns

1

Implements SuitFunc.

---

The documentation for this class was generated from the following files:

• src/include/suitfunc.h
• src/suitfunc.cc