StockVariable Class Reference

This is the class used to calculate the value of the stock-dependent variables used in the model simulation. More...

#include <stockvariable.h>

Collaboration diagram for StockVariable:

Public Member Functions
	StockVariable ()
	This is the default StockVariable constructor. More...
	~StockVariable ()
	This is the default StockVariable destructor. More...
void	read (CommentStream &infile)
	This function will read StockVariable data from file. More...
double	getValue () const
	This function will return the value of the StockVariable. More...
void	Interchange (StockVariable &newSV) const
	This function will swap the StockVariable value for a new value. More...
void	Update ()
	This function will update the StockVariable value. More...
void	Delete () const
	This function will delete a StockVariable value. More...

Detailed Description

This is the class used to calculate the value of the stock-dependent variables used in the model simulation.

Constructor & Destructor Documentation

StockVariable()

StockVariable::StockVariable ( )

inline

This is the default StockVariable constructor.

~StockVariable()

StockVariable::~StockVariable

(

)

This is the default StockVariable destructor.

Member Function Documentation

Delete()

void StockVariable::Delete

(

)

const

This function will delete a StockVariable value.

getValue()

double StockVariable::getValue ( ) const

inline

This function will return the value of the StockVariable.

Returns

the value of the StockVariable

Interchange()

void StockVariable::Interchange

(

StockVariable &

newSV

)

const

This function will swap the StockVariable value for a new value.

Parameters

newSV

is the new StockVariable value

read()

void StockVariable::read

(

CommentStream &

infile

)

This function will read StockVariable data from file.

Parameters

infile

is the CommentStream to read the data from

Update()

void StockVariable::Update

(

)

This function will update the StockVariable value.

---

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

• src/include/stockvariable.h
• src/stockvariable.cc