This is the class used to print information about one or more stocks. More...

#include <stockprinter.h>

Inheritance diagram for StockPrinter:

Collaboration diagram for StockPrinter:

Public Member Functions
	StockPrinter (CommentStream &infile, const TimeClass *const TimeInfo)
	This is the default StockPrinter constructor. More...

virtual	~StockPrinter ()
	This is the default StockPrinter 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
IntMatrix	areas
	This is the IntMatrix used to store aggregated area information. More...

IntMatrix	ages
	This is the IntMatrix used to store aggregated age information. More...

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

CharPtrVector	ageindex
	This is the CharPtrVector of the names of the aggregated ages to print. More...

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

CharPtrVector	stocknames
	This is the CharPtrVector of the names of the stocks to print. More...

LengthGroupDivision *	LgrpDiv
	This is the LengthGroupDivision of the stock. More...

StockAggregator *	aggregator
	This is the StockAggregator used to collect information about the stocks. More...

const AgeBandMatrixPtrVector *	alptr
	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 information about one or more stocks.

Constructor & Destructor Documentation

◆ StockPrinter()

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

This is the default StockPrinter constructor.

Parameters

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

◆ ~StockPrinter()

StockPrinter::~StockPrinter ( )

virtual

This is the default StockPrinter destructor.

Member Function Documentation

◆ Print()

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

◆ setStock()

void StockPrinter::setStock	(	StockPtrVector &	stockvec,
		const AreaClass *const	Area
	)

virtual

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

Parameters

stockvec	is the StockPtrVector of all the available stocks
Area	is the AreaClass for the current model

Reimplemented from Printer.

Member Data Documentation

◆ ageindex

CharPtrVector StockPrinter::ageindex

protected

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

◆ ages

IntMatrix StockPrinter::ages

protected

This is the IntMatrix used to store aggregated age information.

◆ aggregator

StockAggregator* StockPrinter::aggregator

protected

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

◆ alptr

const AgeBandMatrixPtrVector* StockPrinter::alptr

protected

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

◆ areaindex

CharPtrVector StockPrinter::areaindex

protected

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

◆ areas

IntMatrix StockPrinter::areas

protected

This is the IntMatrix used to store aggregated area information.

◆ lenindex

CharPtrVector StockPrinter::lenindex

protected

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

◆ LgrpDiv

LengthGroupDivision* StockPrinter::LgrpDiv

protected

This is the LengthGroupDivision of the stock.

◆ stocknames

CharPtrVector StockPrinter::stocknames

protected

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

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

src/include/stockprinter.h
src/stockprinter.cc

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ StockPrinter()

◆ ~StockPrinter()

Member Function Documentation

◆ Print()

◆ setStock()

Member Data Documentation

◆ ageindex

◆ ages

◆ aggregator

◆ alptr

◆ areaindex

◆ areas

◆ lenindex

◆ LgrpDiv

◆ stocknames