This is the class used to model a stock within the Gadget model. More...

#include <stock.h>

Inheritance diagram for Stock:

Collaboration diagram for Stock:

Public Member Functions
	Stock (CommentStream &infile, const char givenname, const AreaClass const Area, const TimeClass const TimeInfo, Keeper const keeper)
	This is the Stock constructor. More...

	Stock (const char *givenname)
	This is the default Stock constructor. More...

virtual	~Stock ()
	This is the default Stock destructor. More...

virtual void	calcNumbers (int area, const TimeClass *const TimeInfo)
	This function will update the model population for an area in the model. More...

virtual void	reducePop (int area, const TimeClass *const TimeInfo)
	This function will reduce the model population for an area in the model. More...

virtual void	Grow (int area, const AreaClass const Area, const TimeClass const TimeInfo)
	This function will calculate the growth of the model population for an area in the model. More...

virtual void	updateAgePart1 (int area, const TimeClass *const TimeInfo)
	This function will calculate any transition of the model population for an area in the model. More...

virtual void	updateAgePart2 (int area, const TimeClass *const TimeInfo)
	This function will calculate the age increase of the model population for an area in the model. More...

virtual void	updateAgePart3 (int area, const TimeClass *const TimeInfo)
	This function will implement the transiton of the model population for an area in the model. More...

virtual void	updatePopulationPart1 (int area, const TimeClass *const TimeInfo)
	This function will calculate the spawning of the model population for an area in the model. More...

virtual void	updatePopulationPart2 (int area, const TimeClass *const TimeInfo)
	This function will calculate add the newly matured stock into the model population for an area in the model. More...

virtual void	updatePopulationPart3 (int area, const TimeClass *const TimeInfo)
	This function will calculate add the new recruits into the model population for an area in the model. More...

virtual void	updatePopulationPart4 (int area, const TimeClass *const TimeInfo)
	This function will calculate calculate the straying of the model population for an area in the model. More...

virtual void	updatePopulationPart5 (int area, const TimeClass *const TimeInfo)
	This function will calculate add the strayed stock into the model population for an area in the model. More...

virtual void	calcEat (int area, const AreaClass const Area, const TimeClass const TimeInfo)
	This function will calculate the modelled consumption for an area in the model. More...

virtual void	checkEat (int area, const TimeClass *const TimeInfo)
	This function will check the modelled consumption for an area in the model. More...

virtual void	adjustEat (int area, const TimeClass *const TimeInfo)
	This function will adjust the modelled consumption for an area in the model. More...

virtual void	Reset (const TimeClass *const TimeInfo)
	This function will reset the model population. More...

void	Print (ofstream &outfile) const
	This function will print the model population. More...

virtual void	Migrate (const TimeClass *const TimeInfo)
	This function will implement the migration of the model population for the model. More...

void	Add (const AgeBandMatrix &Addition, const ConversionIndex *const CI, int area, double ratio)
	This function will add a AgeBandMatrix to the current stock population. More...

void	Add (const AgeBandMatrixRatioPtrVector &Addition, const ConversionIndex *const CI, int area, double ratio)
	This function will add a AgeBandMatrixRatioPtrVector to the current tagged stock population. More...

StockPrey *	getPrey () const
	This will return the prey information for the stock. More...

Migration *	getMigration () const
	This will return the migration information for the stock. More...

PopPredator *	getPredator () const
	This will return the predation information for the stock. More...

AgeBandMatrix &	getCurrentALK (int area)
	This will return the current population of the stock on a given area. More...

AgeBandMatrix &	getConsumptionALK (int area)
	This will return the population of the stock on a given area at the start of the current timestep. More...

const LengthGroupDivision *	getLengthGroupDiv () const
	This will return the length group information for the stock. More...

void	setStock (StockPtrVector &stockvec)
	This function will initialise the stock and set-up links to any related stocks. More...

int	isBirthday (const TimeClass *const TimeInfo) const
	This function will check to see if the age of the stock should be increased on the current timestep or not. More...

int	isEaten () const
	This function will return the flag used to denote whether the stock is eaten or not. More...

int	doesSpawn () const
	This function will return the flag used to denote whether the stock will spawn or not. More...

int	doesStray () const
	This function will return the flag used to denote whether the stock will stray or not. More...

int	doesMove () const
	This function will return the flag used to denote whether the stock will move or not. More...

int	doesEat () const
	This function will return the flag used to denote whether the stock will eat or not. More...

int	doesMature () const
	This function will return the flag used to denote whether the stock will mature or not. More...

int	doesRenew () const
	This function will return the flag used to denote whether the stock will renew or not. More...

int	doesGrow () const
	This function will return the flag used to denote whether the stock will grow or not. More...

int	doesMigrate () const
	This function will return the flag used to denote whether the stock will migrate or not. More...

int	isTagged () const
	This function will return the flag used to denote whether the stock has been tagged or not. More...

void	setTaggedStock ()
	This function will set the flag to denote that the stock has been tagged. More...

void	setTagged ()
	This function will initialise the tagging experiments for the stock and any related stocks. More...

int	minAge () const
	This will return the minimum age of the stock. More...

int	maxAge () const
	This will return the maximum age of the stock. More...

double	getTotalStockNumber (int area) const
	This will return the total population size (in numbers) of the stock on a given area. More...

double	getTotalStockNumberAllAreas () const
	This will return the total population size (in numbers) of the stock across all areas. More...

double	getTotalStockBiomass (int area) const
	This will return the total population biomass of the stock on a given area. More...

double	getTotalStockBiomassAllAreas () const
	This will return the total population biomass of the stock across all areas. More...

double	getWeightedStockBiomass (int area, const FormulaVector &parameters) const
	This will return the selection weighted population biomass \of the stock in one area return population biomass. More...

double	getWeightedStockBiomassAllAreas (const FormulaVector &parameters) const
	This will return the selection weighted population biomass \of the stock in allareas return population biomass. More...

const StockPtrVector &	getMatureStocks ()
	This will return the stocks that this stock will mature in to. More...

const StockPtrVector &	getTransitionStocks ()
	This will return the stocks that this stock will move in to. More...

const StockPtrVector &	getStrayStocks ()
	This will return the stocks that this stock will stray in to. More...

void	addTags (AgeBandMatrixPtrVector tagbyagelength, Tags newtag, double tagloss)
	This function will add details for a new tagging experiment on the current stock. More...

void	deleteTags (const char *tagname)
	This function will remove a tagging experiment from the current tagged stock population. More...

Public Member Functions inherited from BaseClass
	BaseClass ()
	This is the default BaseClass constructor. More...

	BaseClass (const char *givenname)
	This is the BaseClass constructor for an object with a name. More...

	BaseClass (const char *givenname, const IntVector &Areas)
	This is the BaseClass constructor for an object with a name and an area. More...

virtual	~BaseClass ()
	This is the default BaseClass destructor. 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...

Public Member Functions inherited from LivesOnAreas
	LivesOnAreas ()
	This is the default LivesOnAreas constructor. More...

virtual	~LivesOnAreas ()
	This is the default LivesOnAreas destructor. More...

	LivesOnAreas (const IntVector &Areas)
	This is the LivesOnAreas constructor for a specified vector of areas. More...

int	isInArea (int area) const
	This function will check whether the object is defined on a specified area. More...

IntVector &	getAreas ()
	This function will return the internal areas that the object is defined on. More...

int	areaNum (int area) const
	This function will return the area associated with an internal area. More...

Protected Attributes
AgeBandMatrixPtrVector	Alkeys
	This is the AgeBandMatrixPtrVector used to store information about the stock population. More...

AgeBandMatrixRatioPtrVector	tagAlkeys
	This is the AgeBandMatrixRatioPtrVector used to store information about the tagged population from any tagging experiments performed on the stock. More...

TagPtrVector	allTags
	This is the TagPtrVector used to store information about the tagging experiments. More...

TagPtrVector	matureTags
	This is the TagPtrVector used to store information about how the tagging experiments affect the population that mature. More...

TagPtrVector	transitionTags
	This is the TagPtrVector used to store information about how the tagging experiments affect the population that move. More...

TagPtrVector	strayTags
	This is the TagPtrVector used to store information about how the tagging experiments affect the population that stray. More...

StrayData *	stray
	This is the StrayData used to calculate information about the straying of the stock. More...

SpawnData *	spawner
	This is the SpawnData used to calculate information about the spawning of the stock. More...

RenewalData *	renewal
	This is the RenewalData used to calculate information about the renewal of the stock. More...

Maturity *	maturity
	This is the Maturity used to calculate information about the maturation of the stock. More...

Transition *	transition
	This is the Transition used to calculate information about the movement of the stock. More...

Migration *	migration
	This is the Migration used to calculate information about the migration of the stock. More...

StockPrey *	prey
	This is the Prey used to calculate information about the consumption of the stock. More...

PopPredator *	predator
	This is the PopPredator used to calculate information about the consumption by the stock. More...

InitialCond *	initial
	This is the InitialCond used to calculate information about the initial conditions of the stock. More...

LengthGroupDivision *	LgrpDiv
	This is the LengthGroupDivision used to store length information. More...

Grower *	grower
	This is the Grower used to calculate information about the growth of the stock. More...

NaturalMortality *	naturalm
	This is the NaturalMortality used to calculate information about the natural mortality of the stock. More...

int	doeseat
	This is the flag used to denote whether the stock will eat (ie. is a Predator) or not. More...

int	doesmove
	This is the flag used to denote whether the stock will move or not. More...

int	iseaten
	This is the flag used to denote whether the stock is eaten (ie. is a Prey) or not. More...

int	doesspawn
	This is the flag used to denote whether the stock will spawn or not. More...

int	doesmature
	This is the flag used to denote whether the stock will mature or not. More...

int	doesrenew
	This is the flag used to denote whether the stock will renew or not. More...

int	doesgrow
	This is the flag used to denote whether the stock will grow or not. More...

int	doesmigrate
	This is the flag used to denote whether the stock will migrate or not. More...

int	doesstray
	This is the flag used to denote whether the stock will stray or not. More...

int	birthdate
	This is the timestep that the population will increase in age in the simulation. More...

int	istagged
	This is the flag used to denote whether the stock has been included in a tagging experiment or not. More...

PopInfoMatrix	tmpPopulation
	This is the PopInfoMatrix used to temporarily store the population during the growth calculation. More...

PopInfoVector	tmpMigrate
	This is the PopInfoVector used to temporarily store the population during the migration calculation. More...

Protected Attributes inherited from LivesOnAreas
IntVector	areas
	This is the IntVector of internal areas that the object is defined on. More...

Additional Inherited Members
Protected Member Functions inherited from LivesOnAreas
void	storeAreas (const IntVector &Areas)
	This function will store the internal areas to be used. More...

Detailed Description

This is the class used to model a stock within the Gadget model.

This class is used to model the population of a stock during a model simulation.

Constructor & Destructor Documentation

◆ Stock() [1/2]

Stock::Stock	(	CommentStream &	infile,
		const char *	givenname,
		const AreaClass *const	Area,
		const TimeClass *const	TimeInfo,
		Keeper *const	keeper
	)

This is the Stock constructor.

Parameters

infile	is the CommentStream to read the stock parameters from
givenname	is the name of the stock
Area	is the AreaClass for the current model
TimeInfo	is the TimeClass for the current model
keeper	is the Keeper for the current model

◆ Stock() [2/2]

Stock::Stock ( const char * givenname )

This is the default Stock constructor.

Parameters

givenname is the name of the stock

◆ ~Stock()

Stock::~Stock ( )

virtual

This is the default Stock destructor.

Member Function Documentation

◆ Add() [1/2]

void Stock::Add	(	const AgeBandMatrix &	Addition,
		const ConversionIndex *const	CI,
		int	area,
		double	ratio
	)

This function will add a AgeBandMatrix to the current stock population.

Parameters

Addition	is the AgeBandMatrix that will be added to the population
CI	is the ConversionIndex that will convert between the length groups
area	is an integer to denote the internal area of interest
ratio	is a multiplicative constant applied

◆ Add() [2/2]

void Stock::Add	(	const AgeBandMatrixRatioPtrVector &	Addition,
		const ConversionIndex *const	CI,
		int	area,
		double	ratio
	)

This function will add a AgeBandMatrixRatioPtrVector to the current tagged stock population.

Parameters

Addition	is the AgeBandMatrixRatioPtrVector that will be added to the tagged population
CI	is the ConversionIndex that will convert between the length groups
area	is an integer to denote the internal area of interest
ratio	is a multiplicative constant applied

◆ addTags()

void Stock::addTags	(	AgeBandMatrixPtrVector *	tagbyagelength,
		Tags *	newtag,
		double	tagloss
	)

This function will add details for a new tagging experiment on the current stock.

Parameters

tagbyagelength	is the AgeBandMatrixPtrVector of the new tagged population
newtag	is the Tags for the new tagging experiment
tagloss	is the proportion of tags that are lost for the new tagging experiment

◆ adjustEat()

void Stock::adjustEat	(	int	area,
		const TimeClass *const	TimeInfo
	)

virtual

This function will adjust the modelled consumption for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

◆ calcEat()

void Stock::calcEat	(	int	area,
		const AreaClass *const	Area,
		const TimeClass *const	TimeInfo
	)

virtual

This function will calculate the modelled consumption for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
Area	is the AreaClass for the current model
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

◆ calcNumbers()

void Stock::calcNumbers	(	int	area,
		const TimeClass *const	TimeInfo
	)

virtual

This function will update the model population for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

◆ checkEat()

void Stock::checkEat	(	int	area,
		const TimeClass *const	TimeInfo
	)

virtual

This function will check the modelled consumption for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

◆ deleteTags()

void Stock::deleteTags ( const char * tagname )

This function will remove a tagging experiment from the current tagged stock population.

Parameters

tagname is the name of the tagging experiment to be removed

◆ doesEat()

int Stock::doesEat ( ) const

inline

This function will return the flag used to denote whether the stock will eat or not.

Returns: flag

◆ doesGrow()

int Stock::doesGrow ( ) const

inline

This function will return the flag used to denote whether the stock will grow or not.

Returns: flag

◆ doesMature()

int Stock::doesMature ( ) const

inline

This function will return the flag used to denote whether the stock will mature or not.

Returns: flag

◆ doesMigrate()

int Stock::doesMigrate ( ) const

inline

This function will return the flag used to denote whether the stock will migrate or not.

Returns: flag

◆ doesMove()

int Stock::doesMove ( ) const

inline

This function will return the flag used to denote whether the stock will move or not.

Returns: flag

◆ doesRenew()

int Stock::doesRenew ( ) const

inline

This function will return the flag used to denote whether the stock will renew or not.

Returns: flag

◆ doesSpawn()

int Stock::doesSpawn ( ) const

inline

This function will return the flag used to denote whether the stock will spawn or not.

Returns: flag

◆ doesStray()

int Stock::doesStray ( ) const

inline

This function will return the flag used to denote whether the stock will stray or not.

Returns: flag

◆ getConsumptionALK()

AgeBandMatrix & Stock::getConsumptionALK ( int area )

This will return the population of the stock on a given area at the start of the current timestep.

Parameters

area	is the area identifier

Returns: alkeys, a AgeBandMatrix containing the population of the stock

◆ getCurrentALK()

AgeBandMatrix& Stock::getCurrentALK ( int area )

inline

This will return the current population of the stock on a given area.

Parameters

area	is the area identifier

Returns: alkeys, a AgeBandMatrix containing the population of the stock

◆ getLengthGroupDiv()

const LengthGroupDivision* Stock::getLengthGroupDiv ( ) const

inline

This will return the length group information for the stock.

Returns: LgrpDiv

◆ getMatureStocks()

const StockPtrVector & Stock::getMatureStocks ( )

This will return the stocks that this stock will mature in to.

Returns: maturestocks, a StockPtrVector of the stocks that this stock will mature into

◆ getMigration()

Migration * Stock::getMigration ( ) const

This will return the migration information for the stock.

Returns: migration

◆ getPredator()

PopPredator * Stock::getPredator ( ) const

This will return the predation information for the stock.

Returns: predator

◆ getPrey()

StockPrey * Stock::getPrey ( ) const

This will return the prey information for the stock.

Returns: prey

◆ getStrayStocks()

const StockPtrVector & Stock::getStrayStocks ( )

This will return the stocks that this stock will stray in to.

Returns: straystocks, a StockPtrVector of the stocks that this stock will stray into

◆ getTotalStockBiomass()

double Stock::getTotalStockBiomass ( int area ) const

This will return the total population biomass of the stock on a given area.

Parameters

area	is the area identifier

Returns: population biomass

◆ getTotalStockBiomassAllAreas()

double Stock::getTotalStockBiomassAllAreas ( ) const

This will return the total population biomass of the stock across all areas.

Returns: population biomass

◆ getTotalStockNumber()

double Stock::getTotalStockNumber ( int area ) const

This will return the total population size (in numbers) of the stock on a given area.

Parameters

area	is the area identifier

Returns: population size

◆ getTotalStockNumberAllAreas()

double Stock::getTotalStockNumberAllAreas ( ) const

This will return the total population size (in numbers) of the stock across all areas.

Returns: population size

◆ getTransitionStocks()

const StockPtrVector & Stock::getTransitionStocks ( )

This will return the stocks that this stock will move in to.

Returns: transitionstocks, a StockPtrVector of the stocks that this stock will move into

◆ getWeightedStockBiomass()

double Stock::getWeightedStockBiomass	(	int	area,
		const FormulaVector &	parameters
	)		const

This will return the selection weighted population biomass \of the stock in one area return population biomass.

◆ getWeightedStockBiomassAllAreas()

double Stock::getWeightedStockBiomassAllAreas ( const FormulaVector & parameters ) const

This will return the selection weighted population biomass \of the stock in allareas return population biomass.

◆ Grow()

void Stock::Grow	(	int	area,
		const AreaClass *const	Area,
		const TimeClass *const	TimeInfo
	)

virtual

This function will calculate the growth of the model population for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
Area	is the AreaClass for the current model
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

◆ isBirthday()

int Stock::isBirthday ( const TimeClass *const TimeInfo ) const

This function will check to see if the age of the stock should be increased on the current timestep or not.

Parameters

TimeInfo is the TimeClass for the current model

Returns: 1 if the age of the stock should be increased, 0 otherwise

◆ isEaten()

int Stock::isEaten ( ) const

inline

This function will return the flag used to denote whether the stock is eaten or not.

Returns: flag

◆ isTagged()

int Stock::isTagged ( ) const

inline

This function will return the flag used to denote whether the stock has been tagged or not.

Returns: flag

◆ maxAge()

int Stock::maxAge ( ) const

inline

This will return the maximum age of the stock.

Returns: maximum age

◆ Migrate()

void Stock::Migrate ( const TimeClass *const TimeInfo )

virtual

This function will implement the migration of the model population for the model.

Parameters

TimeInfo is the TimeClass for the current model

Implements BaseClass.

◆ minAge()

int Stock::minAge ( ) const

inline

This will return the minimum age of the stock.

Returns: minimum age

◆ Print()

void Stock::Print ( ofstream & outfile ) const

virtual

This function will print the model population.

Parameters

outfile is the ofstream that all the model information gets sent to

Implements BaseClass.

◆ reducePop()

void Stock::reducePop	(	int	area,
		const TimeClass *const	TimeInfo
	)

virtual

This function will reduce the model population for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

◆ Reset()

void Stock::Reset ( const TimeClass *const TimeInfo )

virtual

This function will reset the model population.

Parameters

TimeInfo is the TimeClass for the current model

Implements BaseClass.

◆ setStock()

void Stock::setStock ( StockPtrVector & stockvec )

This function will initialise the stock and set-up links to any related stocks.

Parameters

stockvec is the StockPtrVector of all the available stocks

◆ setTagged()

void Stock::setTagged ( )

This function will initialise the tagging experiments for the stock and any related stocks.

◆ setTaggedStock()

void Stock::setTaggedStock ( )

inline

This function will set the flag to denote that the stock has been tagged.

◆ updateAgePart1()

void Stock::updateAgePart1	(	int	area,
		const TimeClass *const	TimeInfo
	)

virtual

This function will calculate any transition of the model population for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

◆ updateAgePart2()

void Stock::updateAgePart2	(	int	area,
		const TimeClass *const	TimeInfo
	)

virtual

This function will calculate the age increase of the model population for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

◆ updateAgePart3()

void Stock::updateAgePart3	(	int	area,
		const TimeClass *const	TimeInfo
	)

virtual

This function will implement the transiton of the model population for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

◆ updatePopulationPart1()

void Stock::updatePopulationPart1	(	int	area,
		const TimeClass *const	TimeInfo
	)

virtual

This function will calculate the spawning of the model population for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

◆ updatePopulationPart2()

void Stock::updatePopulationPart2	(	int	area,
		const TimeClass *const	TimeInfo
	)

virtual

This function will calculate add the newly matured stock into the model population for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

◆ updatePopulationPart3()

void Stock::updatePopulationPart3	(	int	area,
		const TimeClass *const	TimeInfo
	)

virtual

This function will calculate add the new recruits into the model population for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

◆ updatePopulationPart4()

void Stock::updatePopulationPart4	(	int	area,
		const TimeClass *const	TimeInfo
	)

virtual

This function will calculate calculate the straying of the model population for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

◆ updatePopulationPart5()

void Stock::updatePopulationPart5	(	int	area,
		const TimeClass *const	TimeInfo
	)

virtual

This function will calculate add the strayed stock into the model population for an area in the model.

Parameters

area	is an integer to denote the internal area of interest
TimeInfo	is the TimeClass for the current model

Implements BaseClass.

Member Data Documentation

◆ Alkeys

AgeBandMatrixPtrVector Stock::Alkeys

protected

This is the AgeBandMatrixPtrVector used to store information about the stock population.

◆ allTags

TagPtrVector Stock::allTags

protected

This is the TagPtrVector used to store information about the tagging experiments.

◆ birthdate

int Stock::birthdate

protected

This is the timestep that the population will increase in age in the simulation.

Note: This is currently set to the last timestep in the year

◆ doeseat

int Stock::doeseat

protected

This is the flag used to denote whether the stock will eat (ie. is a Predator) or not.

◆ doesgrow

int Stock::doesgrow

protected

This is the flag used to denote whether the stock will grow or not.

◆ doesmature

int Stock::doesmature

protected

This is the flag used to denote whether the stock will mature or not.

◆ doesmigrate

int Stock::doesmigrate

protected

This is the flag used to denote whether the stock will migrate or not.

◆ doesmove

int Stock::doesmove

protected

This is the flag used to denote whether the stock will move or not.

◆ doesrenew

int Stock::doesrenew

protected

This is the flag used to denote whether the stock will renew or not.

◆ doesspawn

int Stock::doesspawn

protected

This is the flag used to denote whether the stock will spawn or not.

◆ doesstray

int Stock::doesstray

protected

This is the flag used to denote whether the stock will stray or not.

◆ grower

Grower* Stock::grower

protected

This is the Grower used to calculate information about the growth of the stock.

◆ initial

InitialCond* Stock::initial

protected

This is the InitialCond used to calculate information about the initial conditions of the stock.

◆ iseaten

int Stock::iseaten

protected

This is the flag used to denote whether the stock is eaten (ie. is a Prey) or not.

◆ istagged

int Stock::istagged

protected

This is the flag used to denote whether the stock has been included in a tagging experiment or not.

◆ LgrpDiv

LengthGroupDivision* Stock::LgrpDiv

protected

This is the LengthGroupDivision used to store length information.

◆ matureTags

TagPtrVector Stock::matureTags

protected

This is the TagPtrVector used to store information about how the tagging experiments affect the population that mature.

◆ maturity

Maturity* Stock::maturity

protected

This is the Maturity used to calculate information about the maturation of the stock.

◆ migration

Migration* Stock::migration

protected

This is the Migration used to calculate information about the migration of the stock.

◆ naturalm

NaturalMortality* Stock::naturalm

protected

This is the NaturalMortality used to calculate information about the natural mortality of the stock.

◆ predator

PopPredator* Stock::predator

protected

This is the PopPredator used to calculate information about the consumption by the stock.

◆ prey

StockPrey* Stock::prey

protected

This is the Prey used to calculate information about the consumption of the stock.

◆ renewal

RenewalData* Stock::renewal

protected

This is the RenewalData used to calculate information about the renewal of the stock.

◆ spawner

SpawnData* Stock::spawner

protected

This is the SpawnData used to calculate information about the spawning of the stock.

◆ stray

StrayData* Stock::stray

protected

This is the StrayData used to calculate information about the straying of the stock.

◆ strayTags

TagPtrVector Stock::strayTags

protected

This is the TagPtrVector used to store information about how the tagging experiments affect the population that stray.

◆ tagAlkeys

AgeBandMatrixRatioPtrVector Stock::tagAlkeys

protected

This is the AgeBandMatrixRatioPtrVector used to store information about the tagged population from any tagging experiments performed on the stock.

◆ tmpMigrate

PopInfoVector Stock::tmpMigrate

protected

This is the PopInfoVector used to temporarily store the population during the migration calculation.

◆ tmpPopulation

PopInfoMatrix Stock::tmpPopulation

protected

This is the PopInfoMatrix used to temporarily store the population during the growth calculation.

◆ transition

Transition* Stock::transition

protected

This is the Transition used to calculate information about the movement of the stock.

◆ transitionTags

TagPtrVector Stock::transitionTags

protected

This is the TagPtrVector used to store information about how the tagging experiments affect the population that move.

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Stock() [1/2]

◆ Stock() [2/2]

◆ ~Stock()

Member Function Documentation

◆ Add() [1/2]

◆ Add() [2/2]

◆ addTags()

◆ adjustEat()

◆ calcEat()

◆ calcNumbers()

◆ checkEat()

◆ deleteTags()

◆ doesEat()

◆ doesGrow()

◆ doesMature()

◆ doesMigrate()

◆ doesMove()

◆ doesRenew()

◆ doesSpawn()

◆ doesStray()

◆ getConsumptionALK()

◆ getCurrentALK()

◆ getLengthGroupDiv()

◆ getMatureStocks()

◆ getMigration()

◆ getPredator()

◆ getPrey()

◆ getStrayStocks()

◆ getTotalStockBiomass()

◆ getTotalStockBiomassAllAreas()

◆ getTotalStockNumber()

◆ getTotalStockNumberAllAreas()

◆ getTransitionStocks()

◆ getWeightedStockBiomass()

◆ getWeightedStockBiomassAllAreas()

◆ Grow()

◆ isBirthday()

◆ isEaten()

◆ isTagged()

◆ maxAge()

◆ Migrate()

◆ minAge()

◆ Print()

◆ reducePop()

◆ Reset()

◆ setStock()

◆ setTagged()

◆ setTaggedStock()

◆ updateAgePart1()

◆ updateAgePart2()

◆ updateAgePart3()

◆ updatePopulationPart1()

◆ updatePopulationPart2()

◆ updatePopulationPart3()

◆ updatePopulationPart4()

◆ updatePopulationPart5()

Member Data Documentation

◆ Alkeys

◆ allTags

◆ birthdate

◆ doeseat

◆ doesgrow

◆ doesmature

◆ doesmigrate

◆ doesmove

◆ doesrenew

◆ doesspawn

◆ doesstray

◆ grower

◆ initial

◆ iseaten

◆ istagged

◆ LgrpDiv

◆ matureTags

◆ maturity