FleetEffortAggregator Class Reference

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

#include <fleeteffortaggregator.h>

Collaboration diagram for FleetEffortAggregator:

Public Member Functions
	FleetEffortAggregator (const FleetPtrVector &Fleets, const StockPtrVector &Stocks, const IntMatrix &Areas)
	This is the FleetEffortAggregator constructor. More...
	~FleetEffortAggregator ()
	This is the default FleetEffortAggregator destructor. More...
void	Reset ()
	This function will reset the fleet catch information. More...
void	Sum ()
	This function will aggregate the fleet catch data. More...
void	Print (ofstream &outfile) const
	This will print the aggregator information to the ofstream specified. More...
const DoubleMatrixPtrVector &	getSum () const
	This will return the DoubleMatrixPtrVector containing the aggregated catch information. More...

Detailed Description

This is the class used to aggregate fleet catch information.

Constructor & Destructor Documentation

FleetEffortAggregator()

FleetEffortAggregator::FleetEffortAggregator	(	const FleetPtrVector &	Fleets,
		const StockPtrVector &	Stocks,
		const IntMatrix &	Areas
	)

This is the FleetEffortAggregator constructor.

Parameters

Fleets	is the FleetPtrVector of the fleets that will be aggregated
Stocks	is the StockPtrVector of the stocks that will be aggregated
Areas	is the IntMatrix of areas that the catch can take place on

~FleetEffortAggregator()

FleetEffortAggregator::~FleetEffortAggregator

(

)

This is the default FleetEffortAggregator destructor.

Member Function Documentation

getSum()

const DoubleMatrixPtrVector& FleetEffortAggregator::getSum ( ) const

inline

This will return the DoubleMatrixPtrVector containing the aggregated catch information.

Returns

total, the DoubleMatrixPtrVector of aggregated catch information

Print()

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

(

)

This function will reset the fleet catch information.

Sum()

void FleetEffortAggregator::Sum

(

)

This function will aggregate the fleet catch data.

---

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

• src/include/fleeteffortaggregator.h
• src/fleeteffortaggregator.cc