PredatorOverPrinter Class Reference

This is the class used to print the overconsumption information for one or more predators. More...

#include <predatoroverprinter.h>

Inheritance diagram for PredatorOverPrinter:

Collaboration diagram for PredatorOverPrinter:

Public Member Functions
	PredatorOverPrinter (CommentStream &infile, const TimeClass *const TimeInfo)
	This is the default PredatorOverPrinter constructor. More...
virtual	~PredatorOverPrinter ()
	This is the default PredatorOverPrinter destructor. More...
void	setPredator (PredatorPtrVector &predatorvec, const AreaClass *const Area)
	This will select the predators required for the printer class to print the requested information. More...
virtual void	Print (const TimeClass *const TimeInfo, int printtime)
	This will print the requested information for the printer class to the ofstream specified. More...
Public Member Functions inherited from Printer
	Printer (PrinterType ptype)
	This is the default Printer constructor. More...
virtual	~Printer ()
	This is the default Printer destructor. More...
virtual void	setStock (StockPtrVector &stockvec, const AreaClass *const Area)
	This will select the stocks required for the printer class to print the requested information. More...
virtual void	setPredAndPrey (PredatorPtrVector &predatorvec, PreyPtrVector &preyvec, const AreaClass *const Area)
	This will select the predators and preys required for the printer class to print the requested information. More...
virtual void	setPrey (PreyPtrVector &preyvec, const AreaClass *const Area)
	This will select the preys required for the printer class to print the requested information. More...
virtual void	setLikelihood (LikelihoodPtrVector &likevec)
	This will select the likelihood components required for the printer class to print the requested information. More...
const char *	getFileName () const
	This will return the name of the output file. More...
PrinterType	getType () const
	This will return the type of printer class. More...

Protected Attributes
IntMatrix	areas
	This is the IntMatrix used to store aggregated area information. More...
CharPtrVector	areaindex
	This is the CharPtrVector of the names of the aggregated areas to print. More...
CharPtrVector	lenindex
	This is the CharPtrVector of the names of the lengths to print. More...
CharPtrVector	predatornames
	This is the CharPtrVector of the names of the predator names to print. More...
LengthGroupDivision *	predLgrpDiv
	This is the LengthGroupDivision of the predator. More...
PredatorOverAggregator *	aggregator
	This is the PredatorOverAggregator used to collect information about the overconsumption. More...
const DoubleMatrix *	dptr
	This is the DoubleMatrix used to temporarily store the information returned from the aggregatation function. More...
Protected Attributes inherited from Printer
ActionAtTimes	AAT
	This ActionAtTimes stores information about when the printer output is required in the model. More...
char *	filename
	This is the name of the output file that all the model information will get sent to. More...
ofstream	outfile
	This ofstream is the file that all the model information gets sent to. More...
int	printtimeid
	This is the flag used to denote whether the printing takes place at the start or the end of the timestep. More...
int	precision
	This is precision which can be used to override the default values when printing the information to the output file. More...
int	width
	This is width used when printing the information to the output file. More...

Detailed Description

This is the class used to print the overconsumption information for one or more predators.

Constructor & Destructor Documentation

PredatorOverPrinter()

PredatorOverPrinter::PredatorOverPrinter	(	CommentStream &	infile,
		const TimeClass *const	TimeInfo
	)

This is the default PredatorOverPrinter constructor.

Parameters

infile	is the CommentStream to read the printer parameters from
TimeInfo	is the TimeClass for the current model

~PredatorOverPrinter()

PredatorOverPrinter::~PredatorOverPrinter ( )

virtual

This is the default PredatorOverPrinter destructor.

Member Function Documentation

Print()

void PredatorOverPrinter::Print ( const TimeClass *const  TimeInfo, int  printtime  )

virtual

This will print the requested information for the printer class to the ofstream specified.

Parameters

TimeInfo	is the TimeClass for the current model
printtime	is the flag to denote when the printing is taking place

Implements Printer.

setPredator()

void PredatorOverPrinter::setPredator ( PredatorPtrVector &  predatorvec, const AreaClass *const  Area  )

virtual

This will select the predators required for the printer class to print the requested information.

Parameters

predatorvec	is the PredatorPtrVector of all the available predators
Area	is the AreaClass for the current model

Reimplemented from Printer.

Member Data Documentation

aggregator

PredatorOverAggregator* PredatorOverPrinter::aggregator

protected

This is the PredatorOverAggregator used to collect information about the overconsumption.

areaindex

CharPtrVector PredatorOverPrinter::areaindex

protected

This is the CharPtrVector of the names of the aggregated areas to print.

areas

IntMatrix PredatorOverPrinter::areas

protected

This is the IntMatrix used to store aggregated area information.

dptr

const DoubleMatrix* PredatorOverPrinter::dptr

protected

This is the DoubleMatrix used to temporarily store the information returned from the aggregatation function.

lenindex

CharPtrVector PredatorOverPrinter::lenindex

protected

This is the CharPtrVector of the names of the lengths to print.

predatornames

CharPtrVector PredatorOverPrinter::predatornames

protected

This is the CharPtrVector of the names of the predator names to print.

predLgrpDiv

LengthGroupDivision* PredatorOverPrinter::predLgrpDiv

protected

This is the LengthGroupDivision of the predator.

---

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

• src/include/predatoroverprinter.h
• src/predatoroverprinter.cc