StockPreyAggregator Class Reference

This is the class used to aggregate stock prey information. More...

#include <stockpreyaggregator.h>

Collaboration diagram for StockPreyAggregator:

Public Member Functions
	StockPreyAggregator (const PreyPtrVector &Preys, const LengthGroupDivision *const LgrpDiv, const IntMatrix &Areas, const IntMatrix &Ages)
	This is the StockPreyAggregator constructor. More...
	~StockPreyAggregator ()
	This is the default StockPreyAggregator destructor. More...
void	Reset ()
	This function will reset the stock prey data. More...
void	Sum ()
	This function will aggregate the stock prey data. More...
const AgeBandMatrixPtrVector &	getSum () const
	This will return the AgeBandMatrixPtrVector containing the aggregated stock prey information. More...
void	Print (ofstream &outfile) const
	This will print the aggregator information to the ofstream specified. More...

Protected Attributes
PreyPtrVector	preys
	This is the PreyPtrVector of the preys that will be aggregated. More...
ConversionIndexPtrVector	CI
	This is the ConversionIndexPtrVector used to convert the length groups of the preys to be aggregated. More...
IntMatrix	areas
	This is the IntMatrix used to store area information. More...
IntMatrix	ages
	This is the IntMatrix used to store age information. More...
AgeBandMatrixPtrVector	total
	This is the AgeBandMatrixPtrVector used to store the aggregated stock prey information. More...
const AgeBandMatrix *	alptr
	This is the AgeBandMatrix used to temporarily store information when aggregating the preys. More...

Detailed Description

This is the class used to aggregate stock prey information.

Constructor & Destructor Documentation

StockPreyAggregator()

StockPreyAggregator::StockPreyAggregator	(	const PreyPtrVector &	Preys,
		const LengthGroupDivision *const	LgrpDiv,
		const IntMatrix &	Areas,
		const IntMatrix &	Ages
	)

This is the StockPreyAggregator constructor.

Parameters

Preys	is the PreyPtrVector of the preys that will be aggregated
LgrpDiv	is the LengthGroupDivision that the preys will be aggregated to
Areas	is the IntMatrix of areas that the preys to be aggregated live on
Ages	is the IntMatrix of ages of the preys to be aggregated

~StockPreyAggregator()

StockPreyAggregator::~StockPreyAggregator

(

)

This is the default StockPreyAggregator destructor.

Member Function Documentation

getSum()

const AgeBandMatrixPtrVector& StockPreyAggregator::getSum ( ) const

inline

This will return the AgeBandMatrixPtrVector containing the aggregated stock prey information.

Returns

total, the AgeBandMatrixPtrVector of aggregated stock information

Print()

void StockPreyAggregator::Print

(

ofstream &

outfile

)

const

This will print the aggregator information to the ofstream specified.

Parameters

outfile

is the ofstream to the file that the aggregator information gets sent to

Reset()

void StockPreyAggregator::Reset

(

)

This function will reset the stock prey data.

Sum()

void StockPreyAggregator::Sum

(

)

This function will aggregate the stock prey data.

Member Data Documentation

ages

IntMatrix StockPreyAggregator::ages

protected

This is the IntMatrix used to store age information.

alptr

const AgeBandMatrix* StockPreyAggregator::alptr

protected

This is the AgeBandMatrix used to temporarily store information when aggregating the preys.

areas

IntMatrix StockPreyAggregator::areas

protected

This is the IntMatrix used to store area information.

CI

ConversionIndexPtrVector StockPreyAggregator::CI

protected

This is the ConversionIndexPtrVector used to convert the length groups of the preys to be aggregated.

preys

PreyPtrVector StockPreyAggregator::preys

protected

This is the PreyPtrVector of the preys that will be aggregated.

total

AgeBandMatrixPtrVector StockPreyAggregator::total

protected

This is the AgeBandMatrixPtrVector used to store the aggregated stock prey information.

---

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

• src/include/stockpreyaggregator.h
• src/stockpreyaggregator.cc