PrintInfo Class Reference

This is the class used to store information about what format the model parameters should be written to file. More...

#include <printinfo.h>

Collaboration diagram for PrintInfo:

Public Member Functions
	PrintInfo ()
	This is the PrintInfo constructor. More...
	PrintInfo (const PrintInfo &pi)
	This is the PrintInfo constructor that creates a copy of an existing PrintInfo. More...
	~PrintInfo ()
	This is the default MainInfo destructor. More...
void	setParamOutFile (char *filename)
	This function will store the filename that the final parameter values will be written to. More...
void	setOutputFile (char *filename)
	This function will store the filename that the model parameters will be written to. More...
void	setPrintIteration (int print)
	This function will set the interval between iterations to be used when printing the model parameters to file. More...
void	setPrecision (int prec)
	This function will set the precision to be used when printing the model parameters. More...
void	checkPrintInfo (int net)
	This function will check the printing intervals and precision values that have been set, and override them with default vakues if required. More...
char *	getOutputFile () const
	This function will return the filename that the model parameters will be written to. More...
char *	getParamOutFile () const
	This function will return the filename that the final parameter values will be written to. More...
int	getPrint () const
	This function will return the flag used to determine whether the model parameters should be printed to file. More...
int	getPrecision () const
	This function will return the precision to be used when printing the model parameters. More...
int	getPrintIteration () const
	This function will return the interval between iterations to be used when printing the model parameters to file. More...

Detailed Description

This is the class used to store information about what format the model parameters should be written to file.

Constructor & Destructor Documentation

PrintInfo() [1/2]

PrintInfo::PrintInfo

(

)

This is the PrintInfo constructor.

PrintInfo() [2/2]

PrintInfo::PrintInfo

(

const PrintInfo &

pi

)

This is the PrintInfo constructor that creates a copy of an existing PrintInfo.

Parameters

pi	is the PrintInfo to copy

~PrintInfo()

PrintInfo::~PrintInfo

(

)

This is the default MainInfo destructor.

Member Function Documentation

checkPrintInfo()

void PrintInfo::checkPrintInfo

(

int

net

)

This function will check the printing intervals and precision values that have been set, and override them with default vakues if required.

Parameters

net	is the flag to denote whether the current model run is a network run or not

getOutputFile()

char* PrintInfo::getOutputFile ( ) const

inline

This function will return the filename that the model parameters will be written to.

Returns

filename

getParamOutFile()

char* PrintInfo::getParamOutFile ( ) const

inline

This function will return the filename that the final parameter values will be written to.

Returns

filename

getPrecision()

int PrintInfo::getPrecision ( ) const

inline

This function will return the precision to be used when printing the model parameters.

Returns

precision

getPrint()

int PrintInfo::getPrint ( ) const

inline

This function will return the flag used to determine whether the model parameters should be printed to file.

Returns

flag

getPrintIteration()

int PrintInfo::getPrintIteration ( ) const

inline

This function will return the interval between iterations to be used when printing the model parameters to file.

Returns

print interval

setOutputFile()

void PrintInfo::setOutputFile

(

char *

filename

)

This function will store the filename that the model parameters will be written to.

Parameters

filename

is the name of the file

setParamOutFile()

void PrintInfo::setParamOutFile

(

char *

filename

)

This function will store the filename that the final parameter values will be written to.

Parameters

filename

is the name of the file

setPrecision()

void PrintInfo::setPrecision ( int  prec )

inline

This function will set the precision to be used when printing the model parameters.

Parameters

prec	is the precision

setPrintIteration()

void PrintInfo::setPrintIteration ( int  print )

inline

This function will set the interval between iterations to be used when printing the model parameters to file.

Parameters

print

is the interval

---

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

• src/include/printinfo.h
• src/printinfo.cc