PredatorOverAggregator Class Reference

This is the class used to aggregate the calculated overconsumption by predators. More...

#include <predatoroveraggregator.h>

Collaboration diagram for PredatorOverAggregator:

Public Member Functions
	PredatorOverAggregator (const PredatorPtrVector &predators, const IntMatrix &Areas, const LengthGroupDivision *const LgrpDiv)
	This is the PredatorOverAggregator constructor. More...
	~PredatorOverAggregator ()
	This is the default PredatorOverAggregator destructor. More...
void	Reset ()
	This will reset the predator overconsumption information. More...
void	Sum ()
	This will aggregate the predator overconsumption that has taken place. More...
const DoubleMatrix &	getSum () const
	This will return the calculated overconsumption. More...

Protected Attributes
PredatorPtrVector	predators
	This is the PredatorPtrVector of predators that will be aggregated. More...
IntMatrix	predConv
	This is the IntMatrix of length groups of the predators. More...
IntMatrix	areas
	This is the IntMatrix used to store area information. More...
DoubleMatrix	total
	This is the DoubleMatrix of the overconsumption that has taken place. More...

Detailed Description

This is the class used to aggregate the calculated overconsumption by predators.

Constructor & Destructor Documentation

PredatorOverAggregator()

PredatorOverAggregator::PredatorOverAggregator	(	const PredatorPtrVector &	predators,
		const IntMatrix &	Areas,
		const LengthGroupDivision *const	LgrpDiv
	)

This is the PredatorOverAggregator constructor.

Parameters

predators	is the PredatorPtrVector of the predators that will be aggregated
Areas	is the IntMatrix of areas that the overconsumption can occur on
LgrpDiv	is the LengthGroupDivision for the predators

~PredatorOverAggregator()

PredatorOverAggregator::~PredatorOverAggregator ( )

inline

This is the default PredatorOverAggregator destructor.

Member Function Documentation

getSum()

const DoubleMatrix& PredatorOverAggregator::getSum ( ) const

inline

This will return the calculated overconsumption.

Returns

total, the DoubleMatrix of overconsumption

Reset()

void PredatorOverAggregator::Reset

(

)

This will reset the predator overconsumption information.

Sum()

void PredatorOverAggregator::Sum

(

)

This will aggregate the predator overconsumption that has taken place.

Member Data Documentation

areas

IntMatrix PredatorOverAggregator::areas

protected

This is the IntMatrix used to store area information.

predators

PredatorPtrVector PredatorOverAggregator::predators

protected

This is the PredatorPtrVector of predators that will be aggregated.

predConv

IntMatrix PredatorOverAggregator::predConv

protected

This is the IntMatrix of length groups of the predators.

total

DoubleMatrix PredatorOverAggregator::total

protected

This is the DoubleMatrix of the overconsumption that has taken place.

---

The documentation for this class was generated from the following files:

• src/include/predatoroveraggregator.h
• src/predatoroveraggregator.cc