Gadget
surveyindices.h
Go to the documentation of this file.
1 #ifndef surveyindices_h
2 #define surveyindices_h
3 
4 #include "likelihood.h"
5 #include "fleet.h"
6 #include "commentstream.h"
7 #include "sionstep.h"
8 
17 class SurveyIndices : public Likelihood {
18 public:
27  SurveyIndices(CommentStream& infile, const AreaClass* const Area,
28  const TimeClass* const TimeInfo, double weight, const char* name);
32  virtual ~SurveyIndices();
37  virtual void addLikelihood(const TimeClass* const TimeInfo);
43  void setFleetsAndStocks(FleetPtrVector& Fleets, StockPtrVector& Stocks);
48  virtual void Reset(const Keeper* const keeper);
53  virtual void Print(ofstream& outfile) const;
59  virtual void printLikelihood(ofstream& outfile, const TimeClass* const TimeInfo) {
60  SI->printLikelihood(outfile, TimeInfo); };
65  virtual void printSummary(ofstream& outfile) { SI->printSummary(outfile, weight); };
66 protected:
70  SIOnStep* SI;
74  IntMatrix areas;
78  CharPtrVector stocknames;
82  CharPtrVector fleetnames;
83 };
84 
85 #endif
AreaClass
This is the class used to store information about the areas used for the current model.
Definition: areatime.h:18
CharPtrVector
This class implements a dynamic vector of char values.
Definition: charptrvector.h:8
CommentStream
This is the class used to strip comments (and whitespace) from any input stream.
Definition: commentstream.h:40
FleetPtrVector
This class implements a dynamic vector of Fleet values.
Definition: fleetptrvector.h:10
IntMatrix
This class implements a dynamic vector of IntVector values.
Definition: intmatrix.h:10
Keeper
This is the class used to store information about the variables that are used in model simulation.
Definition: keeper.h:17
Likelihood
This is the base class used to calculate the likelihood scores used to compare the modelled data in t...
Definition: likelihood.h:24
Likelihood::weight
double weight
This stores the weight to be applied to the likelihood component.
Definition: likelihood.h:112
SIOnStep
This is the base class used to calculate a likelihood score by fitting a regression line to the model...
Definition: sionstep.h:29
SIOnStep::printLikelihood
virtual void printLikelihood(ofstream &outfile, const TimeClass *const TimeInfo)
This function will print information from each SIOnStep regression calculation.
Definition: sionstep.cc:278
SIOnStep::printSummary
virtual void printSummary(ofstream &outfile, const double weight)
This function will print summary information from each SIOnStep regression calculation.
Definition: sionstep.cc:359
StockPtrVector
This class implements a dynamic vector of Stock values.
Definition: stockptrvector.h:10
SurveyIndices
This is the class used to calculate a likelihood score by fitting a linear regression line to calcula...
Definition: surveyindices.h:17
SurveyIndices::~SurveyIndices
virtual ~SurveyIndices()
This is the default SurveyIndices destructor.
Definition: surveyindices.cc:212
SurveyIndices::SI
SIOnStep * SI
This is the SIOnStep used to calculate the likelihood score by fitting a linear regression line to th...
Definition: surveyindices.h:65
SurveyIndices::areas
IntMatrix areas
This is the IntMatrix used to store area information.
Definition: surveyindices.h:74
SurveyIndices::addLikelihood
virtual void addLikelihood(const TimeClass *const TimeInfo)
This function will calculate the likelihood score for the SurveyIndices component.
Definition: surveyindices.cc:221
SurveyIndices::stocknames
CharPtrVector stocknames
This is the CharPtrVector of the names of the stocks that will be used to calculate the likelihood sc...
Definition: surveyindices.h:78
SurveyIndices::Print
virtual void Print(ofstream &outfile) const
This function will print the summary SurveyIndices likelihood information.
Definition: surveyindices.cc:301
SurveyIndices::setFleetsAndStocks
void setFleetsAndStocks(FleetPtrVector &Fleets, StockPtrVector &Stocks)
This will select the fleets and stocks required to calculate the SurveyIndices likelihood score.
Definition: surveyindices.cc:227
SurveyIndices::SurveyIndices
SurveyIndices(CommentStream &infile, const AreaClass *const Area, const TimeClass *const TimeInfo, double weight, const char *name)
This is the SurveyIndices constructor.
Definition: surveyindices.cc:16
SurveyIndices::printLikelihood
virtual void printLikelihood(ofstream &outfile, const TimeClass *const TimeInfo)
This function will print information from each SurveyIndices calculation.
Definition: surveyindices.h:59
SurveyIndices::printSummary
virtual void printSummary(ofstream &outfile)
This function will print summary information from each SurveyIndices likelihood calculation.
Definition: surveyindices.h:65
SurveyIndices::fleetnames
CharPtrVector fleetnames
This is the CharPtrVector of the names of any fleets that will be used to calculate the likelihood sc...
Definition: surveyindices.h:82
SurveyIndices::Reset
virtual void Reset(const Keeper *const keeper)
This function will reset the SurveyIndices likelihood information.
Definition: surveyindices.cc:294
TimeClass
This is the class used to store information about the timesteps used for the current model.
Definition: areatime.h:87
Generated by doxygen 1.9.1