Annotation of /trunk/gadget/preyoverprinter.h

Parent Directory | Revision Log

---

Revision 1 - (view) (download)

1 :	agomez	1	#ifndef preyoverprinter_h
2 :			#define preyoverprinter_h
3 :
4 :			#include "printer.h"
5 :			#include "preyoveraggregator.h"
6 :
7 :			/**
8 :			* \class PreyOverPrinter
9 :			* \brief This is the class used to print the overconsumption information for one or more preys
10 :			*/
11 :			class PreyOverPrinter : public Printer {
12 :			public:
13 :			/**
14 :			* \brief This is the default PreyOverPrinter constructor
15 :			* \param infile is the CommentStream to read the printer parameters from
16 :			* \param TimeInfo is the TimeClass for the current model
17 :			*/
18 :			PreyOverPrinter(CommentStream& infile, const TimeClass* const TimeInfo);
19 :			/**
20 :			* \brief This is the default PreyOverPrinter destructor
21 :			*/
22 :			virtual ~PreyOverPrinter();
23 :			/**
24 :			* \brief This will select the preys required for the printer class to print the requested information
25 :			* \param preyvec is the PreyPtrVector of all the available preys
26 :			* \param Area is the AreaClass for the current model
27 :			*/
28 :			void setPrey(PreyPtrVector& preyvec, const AreaClass* const Area);
29 :			/**
30 :			* \brief This will print the requested information for the printer class to the ofstream specified
31 :			* \param TimeInfo is the TimeClass for the current model
32 :			* \param printtime is the flag to denote when the printing is taking place
33 :			*/
34 :			virtual void Print(const TimeClass* const TimeInfo, int printtime);
35 :			protected:
36 :			/**
37 :			* \brief This is the IntMatrix used to store aggregated age information
38 :			*/
39 :			IntMatrix areas;
40 :			/**
41 :			* \brief This is the CharPtrVector of the names of the aggregated areas to print
42 :			*/
43 :			CharPtrVector areaindex;
44 :			/**
45 :			* \brief This is the CharPtrVector of the names of the lengths to print
46 :			*/
47 :			CharPtrVector lenindex;
48 :			/**
49 :			* \brief This is the CharPtrVector of the names of the prey names to print
50 :			*/
51 :			CharPtrVector preynames;
52 :			/**
53 :			* \brief This is the LengthGroupDivision of the prey
54 :			*/
55 :			LengthGroupDivision* preyLgrpDiv;
56 :			/**
57 :			* \brief This is the PreyOverAggregator used to collect information about the overconsumption
58 :			*/
59 :			PreyOverAggregator* aggregator;
60 :			/**
61 :			* \brief This is the DoubleMatrix used to temporarily store the information returned from the aggregatation function
62 :			*/
63 :			const DoubleMatrix* dptr;
64 :			};
65 :
66 :			#endif

---

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