Gadget
Public Member Functions | List of all members
RecAggregator Class Reference

This is the class used to aggregate the recaptured tagged stock information. More...

#include <recaggregator.h>

Collaboration diagram for RecAggregator:
Collaboration graph

Public Member Functions

 RecAggregator (const FleetPtrVector &Fleets, const StockPtrVector &Stocks, LengthGroupDivision *const Lgrpdiv, const IntMatrix &Areas, const IntMatrix &Ages, Tags *tag)
 This is the RecAggregator constructor. More...
 
 ~RecAggregator ()
 This is the default RecAggregator destructor. More...
 
LengthGroupDivisiongetLengthGroupDiv () const
 This function will return the LengthGroupDivision of the aggregator. More...
 
void Reset ()
 This function will reset the recapture data. More...
 
void Sum ()
 This function will aggregate the recapture data. More...
 
void Print (ofstream &outfile) const
 This will print the aggregator information to the ofstream specified. More...
 
const AgeBandMatrixPtrVectorgetSum () const
 This will return the AgeBandMatrixPtrVector containing the aggregated recaptures information. More...
 

Detailed Description

This is the class used to aggregate the recaptured tagged stock information.

Constructor & Destructor Documentation

◆ RecAggregator()

RecAggregator::RecAggregator ( const FleetPtrVector Fleets,
const StockPtrVector Stocks,
LengthGroupDivision *const  Lgrpdiv,
const IntMatrix Areas,
const IntMatrix Ages,
Tags tag 
)

This is the RecAggregator constructor.

Parameters
Stocksis the StockPtrVector of the stocks that will be recaptured
Fleetsis the FleetPtrVector of the fleets that will be recapturing the tagged fish
Lgrpdivis the LengthGroupDivision of the recaptured fish
Areasis the IntMatrix of areas that the recaptures can take place on
Agesis the IntMatrix of ages of the recaptures
tagis the Tags of the tagging experiments

◆ ~RecAggregator()

RecAggregator::~RecAggregator ( )

This is the default RecAggregator destructor.

Member Function Documentation

◆ getLengthGroupDiv()

LengthGroupDivision* RecAggregator::getLengthGroupDiv ( ) const
inline

This function will return the LengthGroupDivision of the aggregator.

Returns
LgrpDiv, the LengthGroupDivision of the aggregator

◆ getSum()

const AgeBandMatrixPtrVector& RecAggregator::getSum ( ) const
inline

This will return the AgeBandMatrixPtrVector containing the aggregated recaptures information.

Returns
total, the AgeBandMatrixPtrVector of aggregated recaptures information

◆ Print()

void RecAggregator::Print ( ofstream &  outfile) const

This will print the aggregator information to the ofstream specified.

Parameters
outfileis the ofstream to the file that the aggregator information gets sent to

◆ Reset()

void RecAggregator::Reset ( )

This function will reset the recapture data.

◆ Sum()

void RecAggregator::Sum ( )

This function will aggregate the recapture data.


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