PreyOverAggregator Class Reference

This is the class used to aggregate the calculated overconsumption of preys. More...

#include <preyoveraggregator.h>

Collaboration diagram for PreyOverAggregator:

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

Protected Attributes
PreyPtrVector	preys
	This is the PreyPtrVector of preys that will be aggregated. More...
IntMatrix	preyConv
	This is the IntMatrix of length groups of the preys. More...
IntMatrix	areas
	This will aggregate the predator overconsumption that has taken place. 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 of preys.

Constructor & Destructor Documentation

PreyOverAggregator()

PreyOverAggregator::PreyOverAggregator	(	const PreyPtrVector &	preys,
		const IntMatrix &	Areas,
		const LengthGroupDivision *const	LgrpDiv
	)

This is the PreyOverAggregator constructor.

Parameters

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

~PreyOverAggregator()

PreyOverAggregator::~PreyOverAggregator ( )

inline

This is the default PreyOverAggregator destructor.

Member Function Documentation

getSum()

const DoubleMatrix& PreyOverAggregator::getSum ( ) const

inline

This will return the calculated overconsumption.

Returns

total, the DoubleMatrix of overconsumption

Reset()

void PreyOverAggregator::Reset

(

)

This will reset the prey overconsumption information.

Sum()

void PreyOverAggregator::Sum

(

)

This will aggregate the prey overconsumption that has taken place.

Member Data Documentation

areas

IntMatrix PreyOverAggregator::areas

protected

This will aggregate the predator overconsumption that has taken place.

preyConv

IntMatrix PreyOverAggregator::preyConv

protected

This is the IntMatrix of length groups of the preys.

preys

PreyPtrVector PreyOverAggregator::preys

protected

This is the PreyPtrVector of preys that will be aggregated.

total

DoubleMatrix PreyOverAggregator::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/preyoveraggregator.h
• src/preyoveraggregator.cc