PopInfo Class Reference

This is the class used to store information about the number, and mean weight, of a population cell of a stock. More...

#include <popinfo.h>

Collaboration diagram for PopInfo:

Public Member Functions
	PopInfo ()
	This is the PopInfo constructor. More...
	~PopInfo ()
	This is the PopInfo destructor. More...
void	operator-= (double a)
	This operator will subtract a number from the PopInfo. More...
void	operator*= (double a)
	This operator will increase the PopInfo by a multiplicative constant. More...
void	setToZero ()
	This function will set the PopInfo to zero. More...
PopInfo &	operator= (const PopInfo &a)
	This operator will set the PopInfo equal to an existing PopInfo. More...
PopInfo &	operator+= (const PopInfo &a)
	This operator will add an existing PopInfo to the current PopInfo. More...
PopInfo	operator* (double a)
	This operator will multiply the PopInfo by a constant. More...

Public Attributes
double	N
	This is the number of fish in the population cell. More...
double	W
	This is the mean weight of the fish in the population cell. More...

Detailed Description

This is the class used to store information about the number, and mean weight, of a population cell of a stock.

Constructor & Destructor Documentation

PopInfo()

PopInfo::PopInfo ( )

inline

This is the PopInfo constructor.

~PopInfo()

PopInfo::~PopInfo ( )

inline

This is the PopInfo destructor.

Member Function Documentation

operator*()

PopInfo PopInfo::operator*

(

double

a

)

This operator will multiply the PopInfo by a constant.

Parameters

a	is the constant

operator*=()

void PopInfo::operator*= ( double  a )

inline

This operator will increase the PopInfo by a multiplicative constant.

Parameters

a	is the multiplicative constant

operator+=()

PopInfo & PopInfo::operator+=

(

const PopInfo &

a

)

This operator will add an existing PopInfo to the current PopInfo.

Parameters

a	is the PopInfo to add

operator-=()

void PopInfo::operator-= ( double  a )

inline

This operator will subtract a number from the PopInfo.

Parameters

a	is the number to subtract

operator=()

PopInfo & PopInfo::operator=

(

const PopInfo &

a

)

This operator will set the PopInfo equal to an existing PopInfo.

Parameters

a	is the PopInfo to copy

setToZero()

void PopInfo::setToZero ( )

inline

This function will set the PopInfo to zero.

Member Data Documentation

N

double PopInfo::N

This is the number of fish in the population cell.

W

double PopInfo::W

This is the mean weight of the fish in the population cell.

---

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

• src/include/popinfo.h
• src/popinfo.cc