Annotation of /trunk/gadget/preyoveraggregator.h

Parent Directory | Revision Log

---

Revision 1 - (view) (download)

1 :	agomez	1	#ifndef preyoveraggregator_h
2 :			#define preyoveraggregator_h
3 :
4 :			#include "agebandmatrix.h"
5 :			#include "intmatrix.h"
6 :			#include "preyptrvector.h"
7 :
8 :			/**
9 :			* \class PreyOverAggregator
10 :			* \brief This is the class used to aggregate the calculated overconsumption of preys
11 :			*/
12 :			class PreyOverAggregator {
13 :			public:
14 :			/**
15 :			* \brief This is the PreyOverAggregator constructor
16 :			* \param preys is the PreyPtrVector of the preys that will be aggregated
17 :			* \param Areas is the IntMatrix of areas that the overconsumption can occur on
18 :			* \param LgrpDiv is the LengthGroupDivision for the preys
19 :			*/
20 :			PreyOverAggregator(const PreyPtrVector& preys,
21 :			const IntMatrix& Areas, const LengthGroupDivision* const LgrpDiv);
22 :			/**
23 :			* \brief This is the default PreyOverAggregator destructor
24 :			*/
25 :			~PreyOverAggregator() {};
26 :			/**
27 :			* \brief This will reset the prey overconsumption information
28 :			*/
29 :			void Reset();
30 :			/**
31 :			* \brief This will aggregate the prey overconsumption that has taken place
32 :			*/
33 :			void Sum();
34 :			/**
35 :			* \brief This will return the calculated overconsumption
36 :			* \return total, the DoubleMatrix of overconsumption
37 :			*/
38 :			const DoubleMatrix& getSum() const { return total; };
39 :			protected:
40 :			/**
41 :			* \brief This is the PreyPtrVector of preys that will be aggregated
42 :			*/
43 :			PreyPtrVector preys;
44 :			/**
45 :			* \brief This is the IntMatrix of length groups of the preys
46 :			*/
47 :			IntMatrix preyConv;
48 :			/**
49 :			* \brief This will aggregate the predator overconsumption that has taken place
50 :			*/
51 :			IntMatrix areas;
52 :			/**
53 :			* \brief This is the DoubleMatrix of the overconsumption that has taken place
54 :			*/
55 :			DoubleMatrix total;
56 :			};
57 :
58 :			#endif

---

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