Annotation of /trunk/gadget/predatoroverprinter.h

Parent Directory | Revision Log

---

Revision 1 - (view) (download)

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

---

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