---

copyOf-ocsReadWriteTools.cc File Reference

#include "ocsReadWriteTools.hh"

Go to the source code of this file.

Functions
int	ReadInt (string ParameterName, string UnitsString, int LowerBound,int UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, int DefaultValue, ifstream * InFile)
long	ReadLongInt (string ParameterName, string UnitsString, long LowerBound, long UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, long DefaultValue, ifstream * InFile)
double	ReadDouble (string ParameterName, string UnitsString, double LowerBound, double UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, double DefaultValue, ifstream * InFile)
string	ReadString (string ParameterName, InputParameterOptionsEnumerator InputParameterOption, string DefaultValue, ifstream * InFile)
int	ReadInt (string ParameterName, string UnitsString, int LowerBound,int UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, ifstream * InFile)
long	ReadLongInt (string ParameterName, string UnitsString, long LowerBound, long UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, ifstream * InFile)
double	ReadDouble (string ParameterName, string UnitsString, double LowerBound, double UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, ifstream * InFile)
string	ReadString (string ParameterName, InputParameterOptionsEnumerator InputParameterOption, ifstream * InFile)
void	MissingParameter (string ParameterName, InputParameterOptionsEnumerator InputParameterOption)
int	ReadInt (string ParameterName, string UnitsString, int LowerBound,int UpperBound, BoundsFlagEnumerator BoundsFlag, ifstream * InFile)
long	ReadLongInt (string ParameterName, string UnitsString, long LowerBound, long UpperBound, BoundsFlagEnumerator BoundsFlag, ifstream * InFile)
double	ReadDouble (string ParameterName, string UnitsString, double LowerBound, double UpperBound, BoundsFlagEnumerator BoundsFlag, ifstream * InFile)
string	ReadString (string ParameterName, ifstream * InFile)
void	cerror (char * msg)
void	LogFileSeparator ()
void	LogFileStars ()
void	LogFileAbortWithErrorMsg (string ErrorMsg)
string	WriteTypeSimulation (typeSimulation TypeSimulation)

---

Function Documentation

void LogFileAbortWithErrorMsg ( string ErrorMsg )

void LogFileSeparator ( )

This function adds a line of # signs to the logfile

void LogFileStars ( )

void MissingParameter ( string ParameterName, InputParameterOptionsEnumerator InputParameterOption )

This function is called by the read functions

double ReadDouble ( string ParameterName, string UnitsString, double LowerBound, double UpperBound, BoundsFlagEnumerator BoundsFlag, ifstream * InFile )

see ReadDouble(string ParameterName, string UnitsString, double LowerBound, double UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, double DefaultValue, ifstream * InFile) for explanation of parameters

double ReadDouble ( string ParameterName, string UnitsString, double LowerBound, double UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, ifstream * InFile )

see ReadDouble(string ParameterName, string UnitsString, double LowerBound, double UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, double DefaultValue, ifstream * InFile) for explanation of parameters

double ReadDouble ( string ParameterName, string UnitsString, double LowerBound, double UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, double DefaultValue, ifstream * InFile )

This function basically reads data types of type double. The name of a parameter and the value of the parameter are first sequentially read from a file (the last value read is returned) and then used to write another file. Specifications are added to the file (based on the value of the parameter). It returns a double value i.e. the value of the parameter with name ParameterName in the input file ifstream *Infile. The function checks that the value of the parameter is within the interval [LB UB] where LB and UB are the lower bound and the upper bound respectively. LowerBound = (-)infinity if Bounds Flag = UPPER_ONLY UpperBound = (+)infinity if Bounds Flag = LOWER_ONLY LB = (-)infinity && UB = (+)infinity if Bounds Flag = NO_BOUNDS LB = Lower Bound UB = UpperBound if BoundsFlag = UPPER_AND_LOWER the units of the parameters are specified by the string UnitString the input parameter option can take the values -- MANDATORY: the parameter must be spread -- OPTIONAL_WARNING: if the parameter is not read, the DefaultValue is used and a warning is printed to the LogFile -- OPTINAL_NO_WARNING: same as for OPTIONAL_WARNING but no warning is written to the LogFile.

int ReadInt ( string ParameterName, string UnitsString, int LowerBound, int UpperBound, BoundsFlagEnumerator BoundsFlag, ifstream * InFile )

see ReadDouble(string ParameterName, string UnitsString, double LowerBound, double UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, double DefaultValue, ifstream * InFile) for explanation of parameters

int ReadInt ( string ParameterName, string UnitsString, int LowerBound, int UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, ifstream * InFile )

see ReadDouble(string ParameterName, string UnitsString, double LowerBound, double UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, double DefaultValue, ifstream * InFile) for explanation of parameters

int ReadInt ( string ParameterName, string UnitsString, int LowerBound, int UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, int DefaultValue, ifstream * InFile )

see ReadDouble(string ParameterName, string UnitsString, double LowerBound, double UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, double DefaultValue, ifstream * InFile) for explanation of parameters

long ReadLongInt ( string ParameterName, string UnitsString, long LowerBound, long UpperBound, BoundsFlagEnumerator BoundsFlag, ifstream * InFile )

see ReadDouble(string ParameterName, string UnitsString, double LowerBound, double UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, double DefaultValue, ifstream * InFile) for explanation of parameters

long ReadLongInt ( string ParameterName, string UnitsString, long LowerBound, long UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, ifstream * InFile )

see ReadDouble(string ParameterName, string UnitsString, double LowerBound, double UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, double DefaultValue, ifstream * InFile) for explanation of parameters

long ReadLongInt ( string ParameterName, string UnitsString, long LowerBound, long UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, long DefaultValue, ifstream * InFile )

see ReadDouble(string ParameterName, string UnitsString, double LowerBound, double UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, double DefaultValue, ifstream * InFile) for explanation of parameters

string ReadString ( string ParameterName, ifstream * InFile )

see ReadDouble(string ParameterName, string UnitsString, double LowerBound, double UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, double DefaultValue, ifstream * InFile) for explanation of parameters

string ReadString ( string ParameterName, InputParameterOptionsEnumerator InputParameterOption, ifstream * InFile )

see ReadDouble(string ParameterName, string UnitsString, double LowerBound, double UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, double DefaultValue, ifstream * InFile) for explanation of parameters

string ReadString ( string ParameterName, InputParameterOptionsEnumerator InputParameterOption, string DefaultValue, ifstream * InFile )

see ReadDouble(string ParameterName, string UnitsString, double LowerBound, double UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, double DefaultValue, ifstream * InFile) for explanation of parameters

string WriteTypeSimulation ( typeSimulation TypeSimulation )

void cerror ( char * msg )

This function is used for debugging.

---