PredatorPreyAggregator Class Reference

This is the class used to aggregate predator-prey information. More...

#include <predatorpreyaggregator.h>

Collaboration diagram for PredatorPreyAggregator:

Public Member Functions
	PredatorPreyAggregator (const PredatorPtrVector &Predators, const PreyPtrVector &Preys, LengthGroupDivision *const Lgrpdiv, const IntMatrix &Areas, const IntMatrix &Ages)
	This is the PredatorPreyAggregator constructor. More...
	~PredatorPreyAggregator ()
	This is the default PredatorPreyAggregator destructor. More...
void	Reset ()
	This function will reset the predation information. More...
void	Sum (const TimeClass *const TimeInfo)
	This function will aggregate the predation data. More...
const AgeBandMatrixPtrVector &	getConsumption () const
	This will return the AgeBandMatrixPtrVector containing the aggregated predation information. More...
const DoubleMatrixPtrVector &	getMortality () const
	This will return the DoubleMatrixPtrVector containing the aggregated mortality information. More...

Detailed Description

This is the class used to aggregate predator-prey information.

Constructor & Destructor Documentation

PredatorPreyAggregator()

PredatorPreyAggregator::PredatorPreyAggregator	(	const PredatorPtrVector &	Predators,
		const PreyPtrVector &	Preys,
		LengthGroupDivision *const	Lgrpdiv,
		const IntMatrix &	Areas,
		const IntMatrix &	Ages
	)

This is the PredatorPreyAggregator constructor.

Parameters

Predators	is the PredatorPtrVector of the predators that will be aggregated
Preys	is the PreyPtrVector of the preys that will be aggregated
Lgrpdiv	is the LengthGroupDivision of the preys
Areas	is the IntMatrix of areas that the predation can take place on
Ages	is the IntMatrix of ages of the preys

~PredatorPreyAggregator()

PredatorPreyAggregator::~PredatorPreyAggregator

(

)

This is the default PredatorPreyAggregator destructor.

Member Function Documentation

getConsumption()

const AgeBandMatrixPtrVector& PredatorPreyAggregator::getConsumption ( ) const

inline

This will return the AgeBandMatrixPtrVector containing the aggregated predation information.

Returns

consume, the AgeBandMatrixPtrVector of aggregated predation information

getMortality()

const DoubleMatrixPtrVector& PredatorPreyAggregator::getMortality ( ) const

inline

This will return the DoubleMatrixPtrVector containing the aggregated mortality information.

Returns

mortality, the DoubleMatrixPtrVector of mortality information

Reset()

void PredatorPreyAggregator::Reset

(

)

This function will reset the predation information.

Sum()

void PredatorPreyAggregator::Sum

(

const TimeClass *const

TimeInfo

)

This function will aggregate the predation data.

Parameters

TimeInfo

is the TimeClass for the current model

---

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

• src/include/predatorpreyaggregator.h
• src/predatorpreyaggregator.cc