Gadget
All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Public Attributes | List of all members
PopRatio Class Reference

This is the class used to store information about the number of tagged fish in a population cell of a stock and ratio of the fish from that population cell that are tagged. More...

#include <popratio.h>

Collaboration diagram for PopRatio:
Collaboration graph

Public Member Functions

 PopRatio ()
 This is the PopRatio constructor. More...
 
 ~PopRatio ()
 This is the PopRatio destructor. More...
 
void operator-= (double a)
 This operator will subtract a number from the PopRatio. More...
 
void operator*= (double a)
 This operator will increase the PopRatio by a multiplicative constant. More...
 
PopRatiooperator= (const PopRatio &a)
 This operator will set the PopRatio equal to an existing PopRatio. More...
 
PopRatiooperator+= (const PopRatio &a)
 This operator will add an existing PopRatio to the current PopRatio. More...
 

Public Attributes

double * N
 This is the number of tagged fish in the population cell. More...
 
double R
 This is the ratio of tagged fish in the population cell. More...
 

Detailed Description

This is the class used to store information about the number of tagged fish in a population cell of a stock and ratio of the fish from that population cell that are tagged.

Constructor & Destructor Documentation

◆ PopRatio()

PopRatio::PopRatio ( )
inline

This is the PopRatio constructor.

◆ ~PopRatio()

PopRatio::~PopRatio ( )
inline

This is the PopRatio destructor.

Member Function Documentation

◆ operator*=()

void PopRatio::operator*= ( double  a)
inline

This operator will increase the PopRatio by a multiplicative constant.

Parameters
ais the multiplicative constant

◆ operator+=()

PopRatio & PopRatio::operator+= ( const PopRatio a)

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

Parameters
ais the PopRatio to add

◆ operator-=()

void PopRatio::operator-= ( double  a)
inline

This operator will subtract a number from the PopRatio.

Parameters
ais the number to subtract

◆ operator=()

PopRatio & PopRatio::operator= ( const PopRatio a)

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

Parameters
ais the PopRatio to copy

Member Data Documentation

◆ N

double* PopRatio::N

This is the number of tagged fish in the population cell.

◆ R

double PopRatio::R

This is the ratio of tagged fish in the population cell.


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