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