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

This is the class used to print likelihood information. More...

#include <likelihoodprinter.h>

Inheritance diagram for LikelihoodPrinter:
Inheritance graph
Collaboration diagram for LikelihoodPrinter:
Collaboration graph

Public Member Functions

 LikelihoodPrinter (CommentStream &infile, const TimeClass *const TimeInfo)
 This is the default LikelihoodPrinter constructor. More...
 
virtual ~LikelihoodPrinter ()
 This is the default LikelihoodPrinter destructor. More...
 
virtual void setLikelihood (LikelihoodPtrVector &likevec)
 This will select the likelihood components 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 setPredator (PredatorPtrVector &predatorvec, const AreaClass *const Area)
 This will select the predators 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

CharPtrVector likenames
 This is the CharPtrVector of the names of the likelihood components to print. More...
 
LikelihoodPtrVector like
 This is the LikelihoodPtrVector that is storing the likelihood component to print. 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 likelihood information.

Constructor & Destructor Documentation

◆ LikelihoodPrinter()

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

This is the default LikelihoodPrinter constructor.

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

◆ ~LikelihoodPrinter()

LikelihoodPrinter::~LikelihoodPrinter ( )
virtual

This is the default LikelihoodPrinter destructor.

Member Function Documentation

◆ Print()

void LikelihoodPrinter::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.

◆ setLikelihood()

void LikelihoodPrinter::setLikelihood ( LikelihoodPtrVector likevec)
virtual

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

Parameters
likevecis the LikelihoodPtrVector of all the available likelihood components

Reimplemented from Printer.

Member Data Documentation

◆ like

LikelihoodPtrVector LikelihoodPrinter::like
protected

This is the LikelihoodPtrVector that is storing the likelihood component to print.

◆ likenames

CharPtrVector LikelihoodPrinter::likenames
protected

This is the CharPtrVector of the names of the likelihood components to print.


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