Log In | Get Help   
Home My Page Projects Code Snippets Project Openings Mareframe
Summary Activity Forums Tracker Lists Tasks Docs Surveys News SCM Files
[mareframe] Annotation of /trunk/gadget/sibyacousticonstep.h
[mareframe] / trunk / gadget / sibyacousticonstep.h Repository:
ViewVC logotype

Annotation of /trunk/gadget/sibyacousticonstep.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1 - (view) (download)

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

root@forge.cesga.es
ViewVC Help
Powered by ViewVC 1.0.0  

Powered By FusionForge