| 1 : |
agomez |
1 |
#ifndef sibyeffortonstep_h
|
| 2 : |
|
|
#define sibyeffortonstep_h
|
| 3 : |
|
|
|
| 4 : |
|
|
#include "sionstep.h" |
| 5 : |
|
|
#include "fleeteffortaggregator.h" |
| 6 : |
|
|
|
| 7 : |
|
|
/**
|
| 8 : |
|
|
* \class SIByEffortOnStep
|
| 9 : |
|
|
* \brief This is the class used to calculate a likelihood score by fitting the model population to effort based data
|
| 10 : |
|
|
*/
|
| 11 : |
|
|
class SIByEffortOnStep : public SIOnStep {
|
| 12 : |
|
|
public:
|
| 13 : |
|
|
/**
|
| 14 : |
|
|
* \brief This is the SIByEffortOnStep constructor
|
| 15 : |
|
|
* \param infile is the CommentStream to read the survey index data from
|
| 16 : |
|
|
* \param areas is the IntMatrix of areas that the survey index can take place on
|
| 17 : |
|
|
* \param areaindex is the CharPtrVector of area identifier text strings
|
| 18 : |
|
|
* \param fleetindex is the CharPtrVector of fleet identifier text strings
|
| 19 : |
|
|
* \param TimeInfo is the TimeClass for the current model
|
| 20 : |
|
|
* \param datafilename is the name of the file containing the survey index data
|
| 21 : |
|
|
* \param givenname is the name of the SIByEffortOnStep likelihood component
|
| 22 : |
|
|
* \param bio is the flag to denote whether the index should be based on the biomass or not
|
| 23 : |
|
|
*/
|
| 24 : |
|
|
SIByEffortOnStep(CommentStream& infile, const IntMatrix& areas,
|
| 25 : |
|
|
const CharPtrVector& areaindex, const CharPtrVector& fleetindex,
|
| 26 : |
|
|
const TimeClass* const TimeInfo, const char* datafilename, const char* givenname, int bio);
|
| 27 : |
|
|
/**
|
| 28 : |
|
|
* \brief This is the default SIByEffortOnStep destructor
|
| 29 : |
|
|
*/
|
| 30 : |
|
|
virtual ~SIByEffortOnStep();
|
| 31 : |
|
|
/**
|
| 32 : |
|
|
* \brief This function will sum the survey index by fleet length data
|
| 33 : |
|
|
* \param TimeInfo is the TimeClass for the current model
|
| 34 : |
|
|
*/
|
| 35 : |
|
|
virtual void Sum(const TimeClass* const TimeInfo);
|
| 36 : |
|
|
/**
|
| 37 : |
|
|
* \brief This will select the fleets and stocks required to calculate the survey index likelihood score
|
| 38 : |
|
|
* \param Fleets is the FleetPtrVector of all the available fleets
|
| 39 : |
|
|
* \param Stocks is the StockPtrVector of all the available stocks
|
| 40 : |
|
|
*/
|
| 41 : |
|
|
virtual void setFleetsAndStocks(FleetPtrVector& Fleets, StockPtrVector& Stocks);
|
| 42 : |
|
|
/**
|
| 43 : |
|
|
* \brief This function will print the SIByEffortOnStep information
|
| 44 : |
|
|
* \param outfile is the ofstream that all the model information gets sent to
|
| 45 : |
|
|
*/
|
| 46 : |
|
|
virtual void Print(ofstream& outfile) const { aggregator->Print(outfile); };
|
| 47 : |
|
|
protected:
|
| 48 : |
|
|
/**
|
| 49 : |
|
|
* \brief This is the FleetEffortAggregator used to collect information about the relevant fleets for the survey index data
|
| 50 : |
|
|
*/
|
| 51 : |
|
|
FleetEffortAggregator* aggregator;
|
| 52 : |
|
|
/**
|
| 53 : |
|
|
* \brief This is the DoubleMatrix used to temporarily store the information returned from the aggregatation function
|
| 54 : |
|
|
*/
|
| 55 : |
|
|
const DoubleMatrix* dptr;
|
| 56 : |
|
|
};
|
| 57 : |
|
|
|
| 58 : |
|
|
#endif
|
Parent Directory
Revision Log