readword.h File Reference

#include "commentstream.h"
#include "modelvariable.h"
#include "formula.h"

Include dependency graph for readword.h:

Go to the source code of this file.

Functions
void	readWordAndVariable (CommentStream &infile, const char *str, int &number)
	This is the function that will read a text string from file, compare this text to a label and if it matches what is expected will then read and store a number. More...
void	readWordAndVariable (CommentStream &infile, const char *str, double &number)
	This is the function that will read a text string from file, compare this text to a label and if it matches what is expected will then read and store a number. More...
void	readWordAndVariable (CommentStream &infile, const char *str, Formula &formula)
	This is the function that will read a text string from file, compare this text to a label and if it matches what is expected will then read and store a Formula. More...
void	readWordAndModelVariable (CommentStream &infile, const char *str, ModelVariable &modelvariable, const TimeClass *const TimeInfo, Keeper *const keeper)
	This is the function that will read a text string from file, compare this text to a label and if it matches what is expected will then read and store a ModelVariable. More...
void	readWordAndValue (CommentStream &infile, const char *str, char *value)
	This is the function that will read a text string from file, compare this text to a label and if it matches what is expected will then read and store a second string. More...
void	readWordAndTwoVariables (CommentStream &infile, const char *str, int &number1, int &number2)
	This is the function that will read a text string from file, compare this text to a label and if it matches what is expected will then read and store 2 number. More...
void	readWordAndTwoVariables (CommentStream &infile, const char *str, double &number1, double &number2)
	This is the function that will read a text string from file, compare this text to a label and if it matches what is expected will then read and store 2 number. More...

Function Documentation

readWordAndModelVariable()

void readWordAndModelVariable	(	CommentStream &	infile,
		const char *	str,
		ModelVariable &	modelvariable,
		const TimeClass *const	TimeInfo,
		Keeper *const	keeper
	)

This is the function that will read a text string from file, compare this text to a label and if it matches what is expected will then read and store a ModelVariable.

Parameters

infile	is the CommentStream to read from
str	is the char* that the text label will be compared to
modelvariable	is the ModelVariable that will store the value that has been read
TimeInfo	is the TimeClass for the current model
keeper	is the Keeper for the current model

readWordAndTwoVariables() [1/2]

void readWordAndTwoVariables	(	CommentStream &	infile,
		const char *	str,
		double &	number1,
		double &	number2
	)

This is the function that will read a text string from file, compare this text to a label and if it matches what is expected will then read and store 2 number.

Parameters

infile	is the CommentStream to read from
str	is the char* that the text label will be compared to
number1	is the double that will store the first value that has been read
number2	is the double that will store the second value that has been read

readWordAndTwoVariables() [2/2]

void readWordAndTwoVariables	(	CommentStream &	infile,
		const char *	str,
		int &	number1,
		int &	number2
	)

This is the function that will read a text string from file, compare this text to a label and if it matches what is expected will then read and store 2 number.

Parameters

infile	is the CommentStream to read from
str	is the char* that the text label will be compared to
number1	is the integer that will store the first value that has been read
number2	is the integer that will store the second value that has been read

readWordAndValue()

void readWordAndValue	(	CommentStream &	infile,
		const char *	str,
		char *	value
	)

This is the function that will read a text string from file, compare this text to a label and if it matches what is expected will then read and store a second string.

Parameters

infile	is the CommentStream to read from
str	is the char* that the text label will be compared to
value	is the char* that will store the value that has been read

readWordAndVariable() [1/3]

void readWordAndVariable	(	CommentStream &	infile,
		const char *	str,
		double &	number
	)

This is the function that will read a text string from file, compare this text to a label and if it matches what is expected will then read and store a number.

Parameters

infile	is the CommentStream to read from
str	is the char* that the text label will be compared to
number	is the double that will store the value that has been read

readWordAndVariable() [2/3]

void readWordAndVariable	(	CommentStream &	infile,
		const char *	str,
		Formula &	formula
	)

This is the function that will read a text string from file, compare this text to a label and if it matches what is expected will then read and store a Formula.

Parameters

infile	is the CommentStream to read from
str	is the char* that the text label will be compared to
formula	is the Formula that will store the value that has been read

readWordAndVariable() [3/3]

void readWordAndVariable	(	CommentStream &	infile,
		const char *	str,
		int &	number
	)

This is the function that will read a text string from file, compare this text to a label and if it matches what is expected will then read and store a number.

Parameters

infile	is the CommentStream to read from
str	is the char* that the text label will be compared to
number	is the integer that will store the value that has been read