Tags Class Reference

#include <tags.h>

Inheritance diagram for Tags:

Collaboration diagram for Tags:

Public Member Functions
	Tags (CommentStream &infile, const char *givenname, const AreaClass *const Area, const TimeClass *const TimeInfo, Keeper *const keeper, StockPtrVector stockvec)
	~Tags ()
void	Update (int timeid)
void	updateTags (int year, int step)
void	deleteStockTags ()
int	getEndYear () const
int	getNumTagTimeSteps () const
CharPtrVector	getStockNames ()
void	setStock (StockPtrVector &Stocks)
void	updateMatureStock (const TimeClass *const TimeInfo)
void	updateTransitionStock (const TimeClass *const TimeInfo)
void	updateStrayStock (const TimeClass *const TimeInfo)
void	storeConsumptionALK (int area, const char *stockname)
const AgeBandMatrix &	getConsumptionALK (int area, const char *stockname)
void	Print (ofstream &outfile) const
	This function will print the model tagged population. More...
void	Reset ()
	This function will reset the model tagged population. More...
int	isWithinPeriod (int year, int step)
int	stockIndex (const char *stockname)
int	areaIndex (const char *stockname, int area)
void	addToTagStock (int timeid)
Public Member Functions inherited from HasName
	HasName ()
	This is the default HasName constructor. More...
virtual	~HasName ()
	This is the default HasName destructor. More...
	HasName (const char *givenname)
	This is the HasName constructor for a specified name. More...
const char *	getName () const
	This will return a null terminated text string containing the name of the object. More...

Constructor & Destructor Documentation

Tags()

Tags::Tags	(	CommentStream &	infile,
		const char *	givenname,
		const AreaClass *const	Area,
		const TimeClass *const	TimeInfo,
		Keeper *const	keeper,
		StockPtrVector	stockvec
	)

~Tags()

Tags::~Tags

(

)

Member Function Documentation

addToTagStock()

void Tags::addToTagStock

(

int

timeid

)

areaIndex()

int Tags::areaIndex	(	const char *	stockname,
		int	area
	)

deleteStockTags()

void Tags::deleteStockTags

(

)

getConsumptionALK()

const AgeBandMatrix & Tags::getConsumptionALK	(	int	area,
		const char *	stockname
	)

getEndYear()

int Tags::getEndYear ( ) const

inline

getNumTagTimeSteps()

int Tags::getNumTagTimeSteps ( ) const

inline

getStockNames()

CharPtrVector Tags::getStockNames ( )

inline

isWithinPeriod()

int Tags::isWithinPeriod	(	int	year,
		int	step
	)

Print()

void Tags::Print

(

ofstream &

outfile

)

const

This function will print the model tagged population.

Parameters

outfile

is the ofstream that all the model information gets sent to

Reset()

void Tags::Reset

(

)

This function will reset the model tagged population.

setStock()

void Tags::setStock

(

StockPtrVector &

Stocks

)

stockIndex()

int Tags::stockIndex

(

const char *

stockname

)

storeConsumptionALK()

void Tags::storeConsumptionALK	(	int	area,
		const char *	stockname
	)

Update()

void Tags::Update

(

int

timeid

)

updateMatureStock()

void Tags::updateMatureStock

(

const TimeClass *const

TimeInfo

)

updateStrayStock()

void Tags::updateStrayStock

(

const TimeClass *const

TimeInfo

)

updateTags()

void Tags::updateTags	(	int	year,
		int	step
	)

updateTransitionStock()

void Tags::updateTransitionStock

(

const TimeClass *const

TimeInfo

)

---

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

• src/include/tags.h
• src/tags.cc