FleetPreyAggregator Class Reference

This is the class used to aggregate fleet catch information. More...

#include <fleetpreyaggregator.h>

Collaboration diagram for FleetPreyAggregator:

Public Member Functions
	FleetPreyAggregator (const FleetPtrVector &Fleets, const StockPtrVector &Stocks, LengthGroupDivision *const Lgrpdiv, const IntMatrix &Areas, const IntMatrix &Ages, int overcons)
	This is the FleetPreyAggregator constructor. More...
	~FleetPreyAggregator ()
	This is the default FleetPreyAggregator destructor. More...
void	Reset ()
	This function will reset the fleet catch information. More...
void	Sum ()
	This function will aggregate the fleet catch data. More...
int	checkCatchData ()
	This function will check the fleet catch data. More...
void	Print (ofstream &outfile) const
	This will print the aggregator information to the ofstream specified. More...
const AgeBandMatrixPtrVector &	getSum () const
	This will return the AgeBandMatrixPtrVector containing the aggregated catch information. More...

Detailed Description

This is the class used to aggregate fleet catch information.

Constructor & Destructor Documentation

FleetPreyAggregator()

FleetPreyAggregator::FleetPreyAggregator	(	const FleetPtrVector &	Fleets,
		const StockPtrVector &	Stocks,
		LengthGroupDivision *const	Lgrpdiv,
		const IntMatrix &	Areas,
		const IntMatrix &	Ages,
		int	overcons
	)

This is the FleetPreyAggregator constructor.

Parameters

Fleets	is the FleetPtrVector of the fleets that will be aggregated
Stocks	is the StockPtrVector of the stocks that will be aggregated
Lgrpdiv	is the LengthGroupDivision of the stocks
Areas	is the IntMatrix of areas that the catch can take place on
Ages	is the IntMatrix of ages of the stocks
overcons	is the flag to determine whether to calculate overconsumption of the stocks

~FleetPreyAggregator()

FleetPreyAggregator::~FleetPreyAggregator

(

)

This is the default FleetPreyAggregator destructor.

Member Function Documentation

checkCatchData()

int FleetPreyAggregator::checkCatchData

(

)

This function will check the fleet catch data.

Returns

1 if there is no catch data found, 0 otherwise

getSum()

const AgeBandMatrixPtrVector& FleetPreyAggregator::getSum ( ) const

inline

This will return the AgeBandMatrixPtrVector containing the aggregated catch information.

Returns

total, the AgeBandMatrixPtrVector of aggregated catch information

Print()

void FleetPreyAggregator::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 FleetPreyAggregator::Reset

(

)

This function will reset the fleet catch information.

Sum()

void FleetPreyAggregator::Sum

(

)

This function will aggregate the fleet catch data.

---

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

• src/include/fleetpreyaggregator.h
• src/fleetpreyaggregator.cc