Gadget
Public Member Functions | Protected Attributes | List of all members
PredatorPrinter Class Reference

This is the class used to print the predation information for one or more predators consuming one or more preys. More...

#include <predatorprinter.h>

Inheritance diagram for PredatorPrinter:
Inheritance graph
Collaboration diagram for PredatorPrinter:
Collaboration graph

Public Member Functions

 PredatorPrinter (CommentStream &infile, const TimeClass *const TimeInfo)
 This is the default PredatorPrinter constructor. More...
 
virtual ~PredatorPrinter ()
 This is the default PredatorPrinter destructor. 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 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 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 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 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 predlenindex
 This is the CharPtrVector of the names of the predator lengths to print. More...
 
CharPtrVector preylenindex
 This is the CharPtrVector of the names of the prey lengths to print. More...
 
CharPtrVector predatornames
 This is the CharPtrVector of the names of the predator names to print. More...
 
CharPtrVector preynames
 This is the CharPtrVector of the names of the prey names to print. More...
 
LengthGroupDivisionpredLgrpDiv
 This is the LengthGroupDivision of the predator. More...
 
LengthGroupDivisionpreyLgrpDiv
 This is the LengthGroupDivision of the prey. More...
 
PredatorAggregatoraggregator
 This is the PredatorAggregator used to collect information about the predation. More...
 
int biomass
 This is the flag used to denote whether the biomass consumed or the numbers consumed is printed to the outfile (default is to print biomass) More...
 
const DoubleMatrixdptr
 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 predation information for one or more predators consuming one or more preys.

Constructor & Destructor Documentation

◆ PredatorPrinter()

PredatorPrinter::PredatorPrinter ( CommentStream infile,
const TimeClass *const  TimeInfo 
)

This is the default PredatorPrinter constructor.

Parameters
infileis the CommentStream to read the printer parameters from
TimeInfois the TimeClass for the current model

◆ ~PredatorPrinter()

PredatorPrinter::~PredatorPrinter ( )
virtual

This is the default PredatorPrinter destructor.

Member Function Documentation

◆ Print()

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

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

Parameters
TimeInfois the TimeClass for the current model
printtimeis the flag to denote when the printing is taking place

Implements Printer.

◆ setPredAndPrey()

void PredatorPrinter::setPredAndPrey ( PredatorPtrVector predatorvec,
PreyPtrVector preyvec,
const AreaClass *const  Area 
)
virtual

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

Parameters
predatorvecis the PredatorPtrVector of all the available predators
preyvecis the PreyPtrVector of all the available preys
Areais the AreaClass for the current model

Reimplemented from Printer.

Member Data Documentation

◆ aggregator

PredatorAggregator* PredatorPrinter::aggregator
protected

This is the PredatorAggregator used to collect information about the predation.

◆ areaindex

CharPtrVector PredatorPrinter::areaindex
protected

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

◆ areas

IntMatrix PredatorPrinter::areas
protected

This is the IntMatrix used to store aggregated area information.

◆ biomass

int PredatorPrinter::biomass
protected

This is the flag used to denote whether the biomass consumed or the numbers consumed is printed to the outfile (default is to print biomass)

◆ dptr

const DoubleMatrix* PredatorPrinter::dptr
protected

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

◆ predatornames

CharPtrVector PredatorPrinter::predatornames
protected

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

◆ predlenindex

CharPtrVector PredatorPrinter::predlenindex
protected

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

◆ predLgrpDiv

LengthGroupDivision* PredatorPrinter::predLgrpDiv
protected

This is the LengthGroupDivision of the predator.

◆ preylenindex

CharPtrVector PredatorPrinter::preylenindex
protected

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

◆ preyLgrpDiv

LengthGroupDivision* PredatorPrinter::preyLgrpDiv
protected

This is the LengthGroupDivision of the prey.

◆ preynames

CharPtrVector PredatorPrinter::preynames
protected

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


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