Annotation of /trunk/gadget/stockfullprinter.h

Parent Directory | Revision Log

---

Revision 1 - (view) (download)

1 :	agomez	1	#ifndef stockfullprinter_h
2 :			#define stockfullprinter_h
3 :
4 :			#include "printer.h"
5 :			#include "stockaggregator.h"
6 :
7 :			/**
8 :			* \class StockFullPrinter
9 :			* \brief This is the class used to print detailed information about a stock
10 :			*/
11 :			class StockFullPrinter : public Printer {
12 :			public:
13 :			/**
14 :			* \brief This is the default StockFullPrinter 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 :			StockFullPrinter(CommentStream& infile, const TimeClass* const TimeInfo);
19 :			/**
20 :			* \brief This is the default StockFullPrinter destructor
21 :			*/
22 :			virtual ~StockFullPrinter();
23 :			/**
24 :			* \brief This will select the stocks required for the printer class to print the requested information
25 :			* \param stockvec is the StockPtrVector of all the available stocks
26 :			* \param Area is the AreaClass for the current model
27 :			*/
28 :			virtual void setStock(StockPtrVector& stockvec, 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 IntVector used to store aggregated area information
38 :			*/
39 :			IntVector outerareas;
40 :			/**
41 :			* \brief This is the minimum age of the stock
42 :			*/
43 :			int minage;
44 :			/**
45 :			* \brief This is the name of the stock
46 :			*/
47 :			char* stockname;
48 :			/**
49 :			* \brief This is the StockAggregator used to collect information about the stock
50 :			*/
51 :			StockAggregator* aggregator;
52 :			/**
53 :			* \brief This is the LengthGroupDivision of the stock
54 :			*/
55 :			LengthGroupDivision* LgrpDiv;
56 :			/**
57 :			* \brief This is the AgeBandMatrixPtrVector used to temporarily store the information returned from the aggregatation function
58 :			*/
59 :			const AgeBandMatrixPtrVector* alptr;
60 :			};
61 :
62 :			#endif

---

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