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

This is the class used to print detailed information about a stock. More...

#include <stockfullprinter.h>

Inheritance diagram for StockFullPrinter:
Inheritance graph
Collaboration diagram for StockFullPrinter:
Collaboration graph

Public Member Functions

 StockFullPrinter (CommentStream &infile, const TimeClass *const TimeInfo)
 This is the default StockFullPrinter constructor. More...
 
virtual ~StockFullPrinter ()
 This is the default StockFullPrinter 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 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 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...
 
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

IntVector outerareas
 This is the IntVector used to store aggregated area information. More...
 
int minage
 This is the minimum age of the stock. More...
 
char * stockname
 This is the name of the stock. More...
 
StockAggregatoraggregator
 This is the StockAggregator used to collect information about the stock. More...
 
LengthGroupDivisionLgrpDiv
 This is the LengthGroupDivision of the stock. More...
 
const AgeBandMatrixPtrVectoralptr
 This is the AgeBandMatrixPtrVector 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 detailed information about a stock.

Constructor & Destructor Documentation

◆ StockFullPrinter()

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

This is the default StockFullPrinter constructor.

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

◆ ~StockFullPrinter()

StockFullPrinter::~StockFullPrinter ( )
virtual

This is the default StockFullPrinter destructor.

Member Function Documentation

◆ Print()

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

◆ setStock()

void StockFullPrinter::setStock ( StockPtrVector stockvec,
const AreaClass *const  Area 
)
virtual

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

Parameters
stockvecis the StockPtrVector of all the available stocks
Areais the AreaClass for the current model

Reimplemented from Printer.

Member Data Documentation

◆ aggregator

StockAggregator* StockFullPrinter::aggregator
protected

This is the StockAggregator used to collect information about the stock.

◆ alptr

const AgeBandMatrixPtrVector* StockFullPrinter::alptr
protected

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

◆ LgrpDiv

LengthGroupDivision* StockFullPrinter::LgrpDiv
protected

This is the LengthGroupDivision of the stock.

◆ minage

int StockFullPrinter::minage
protected

This is the minimum age of the stock.

◆ outerareas

IntVector StockFullPrinter::outerareas
protected

This is the IntVector used to store aggregated area information.

◆ stockname

char* StockFullPrinter::stockname
protected

This is the name of the stock.


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