Functions | Variables

ocsReadWriteTools.cc File Reference

#include "ocsReadWriteTools.hh"

Functions

int ReadInt (string ParameterName, string UnitsString, int LowerBound, int UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, int DefaultValue, ifstream *InFile)
int ReadInt (string ParameterName, string UnitsString, int LowerBound, int UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, int DefaultValue, ifstream *InFile, bool DebugLevel)
long ReadLongInt (string ParameterName, string UnitsString, int LowerBound, int UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, int DefaultValue, ifstream *InFile)
long ReadLongInt (string ParameterName, string UnitsString, int LowerBound, int UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, int DefaultValue, ifstream *InFile, bool DebugLevel)
double ReadDouble (string ParameterName, string UnitsString, double LowerBound, double UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, double DefaultValue, ifstream *InFile)
double ReadDouble (string ParameterName, string UnitsString, double LowerBound, double UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, double DefaultValue, ifstream *InFile, bool DebugLevel)
string ReadString (string ParameterName, InputParameterOptionsEnumerator InputParameterOption, string DefaultValue, ifstream *InFile)
string ReadString (string ParameterName, InputParameterOptionsEnumerator InputParameterOption, string DefaultValue, ifstream *InFile, bool DebugLevel)
int ReadInt (string ParameterName, string UnitsString, int LowerBound, int UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, ifstream *InFile)
int ReadInt (string ParameterName, string UnitsString, int LowerBound, int UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, ifstream *InFile, bool DebugLevel)
long ReadLongInt (string ParameterName, string UnitsString, int LowerBound, int UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, ifstream *InFile)
long ReadLongInt (string ParameterName, string UnitsString, int LowerBound, int UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, ifstream *InFile, bool DebugLevel)
double ReadDouble (string ParameterName, string UnitsString, double LowerBound, double UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, ifstream *InFile)
double ReadDouble (string ParameterName, string UnitsString, double LowerBound, double UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, ifstream *InFile, bool DebugLevel)
string ReadString (string ParameterName, InputParameterOptionsEnumerator InputParameterOption, ifstream *InFile)
string ReadString (string ParameterName, InputParameterOptionsEnumerator InputParameterOption, ifstream *InFile, bool DebugLevel)
void MissingParameter (string ParameterName, InputParameterOptionsEnumerator InputParameterOption)
void MissingParameter (string ParameterName, InputParameterOptionsEnumerator InputParameterOption, bool DebugLevel)
int ReadInt (string ParameterName, string UnitsString, int LowerBound, int UpperBound, BoundsFlagEnumerator BoundsFlag, ifstream *InFile)
int ReadInt (string ParameterName, string UnitsString, int LowerBound, int UpperBound, BoundsFlagEnumerator BoundsFlag, ifstream *InFile, bool DebugLevel)
long ReadLongInt (string ParameterName, string UnitsString, long LowerBound, long UpperBound, BoundsFlagEnumerator BoundsFlag, ifstream *InFile)
long ReadLongInt (string ParameterName, string UnitsString, long LowerBound, long UpperBound, BoundsFlagEnumerator BoundsFlag, ifstream *InFile, bool DebugLevel)
double ReadDouble (string ParameterName, string UnitsString, double LowerBound, double UpperBound, BoundsFlagEnumerator BoundsFlag, ifstream *InFile)
double ReadDouble (string ParameterName, string UnitsString, double LowerBound, double UpperBound, BoundsFlagEnumerator BoundsFlag, ifstream *InFile, bool DebugLevel)
string ReadString (string ParameterName, ifstream *InFile)
string ReadString (string ParameterName, ifstream *InFile, bool DebugLevel)
void cerror (char *msg)
void LogFileSeparator ()
void LogFileStars ()
void LogFileAbortWithErrorMsg (string ErrorMsg)
string WriteTypeSimulation (typeSimulation TypeSimulation)
double * ReadVectorOfDoubles (string ParameterName, string UnitsString, double LowerBound, double UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, double DefaultValue, unsigned NumbersOfElements, ifstream *InFile)
double * ReadVectorOfDoubles (string ParameterName, string UnitsString, double LowerBound, double UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, double DefaultValue, unsigned NumberOfElements, ifstream *InFile, bool DebugLevel)
void WrongTypeParameter (string ParameterName)
void WrongTypeParameter (string ParameterName, bool DebugLevel)
unsigned ReadUnsignedInt (string ParameterName, string UnitsString, unsigned LowerBound, unsigned UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, unsigned DefaultValue, ifstream *InFile)
unsigned ReadUnsignedInt (string ParameterName, string UnitsString, unsigned LowerBound, unsigned UpperBound, BoundsFlagEnumerator BoundsFlag, InputParameterOptionsEnumerator InputParameterOption, unsigned DefaultValue, ifstream *InFile, bool DebugLevel)

Variables

ofstream * LogFile

Function Documentation

void cerror ( char *  msg  ) 

Referenced by OptFiberLocalError::AllocateMemoryForEulerAngles(), ReadDouble(), ReadInt(), ReadLongInt(), ReadUnsignedInt(), ReadVectorOfDoubles(), and OptSignal::WritePowerdBmFreqWindow().

void LogFileAbortWithErrorMsg ( string  ErrorMsg  ) 

Referenced by ElecSignalStat::ComputePhaseTargetFreq(), ElecSignalStat::ComputeTargetFreqIndex(), ElecSignalStat::GetTargetIndexTime(), and ElecSignalStat::GetTargetTime().

void LogFileSeparator (  ) 

Referenced by ReduOptAmplifier::AmplifyOptSignal(), OptAmplifier::AmplifyOptSignal(), ElecSignalStat::CheckGaussianStatisticsInitialization(), ChiSquareReceiver::ChiSquareReceiver(), Histogram2D::Clear(), OptSignal::ConstructOptSignal(), ReduOptFiber::CopyReduOptFiber(), ElecFilter::ElecFilter(), ElecSignalStat::ElecSignalStat(), GaussianReceiver::GaussianReceiver(), OptSignal::GenerateSignalStringUsingInputSequence(), Histogram2D::Histogram2D(), PostDispCompSubSystem::InitApril2003(), ElecEqualizer::InitElecEqualizer(), Histogram::InitHistogram(), ElecSignalStat::InitPatternStats(), ReceiverSubsystem::InitSimplifiedReceiver(), LogFileAbortWithErrorMsg(), LumpedLoss::LumpedLoss(), MachZehnder::MachZehnder(), NoiseCovariance::NoiseCovariance(), OptAmplifier::OptAmplifier(), OptDataWriter::OptDataWriter(), OptFiber::OptFiber(), OptFiberLocalError::OptFiberLocalError(), OptFilter::OptFilter(), OptSignal::OptSignal(), OptSpectrumAnalyzer::OptSpectrumAnalyzer(), Photodetector::Photodetector(), PolarizTransformer::PolarizTransformer(), PolDepAttenuator::PolDepAttenuator(), PostDispCompSubSystem::PostDispCompSubSystem(), ReduOptSignal::ProcessReduOptSignalParameters(), RamanAmp::RamanAmp(), RanNumGen::RanNumGen(), ElecFilter::ReadElecGain(), ElecFilter::ReadElecPhase(), ElecFilter::ReadElecPhasePaola(), OptAmplifier::ReadGainPowerDependent(), OptAmplifier::ReadGainProfile(), OptAmplifier::ReadInGainFlatenFilter(), OptAmplifier::ReadInPolynomialFilter(), RamanAmp::ReadPlainFileGainLoss(), RamanAmp::ReadRamanGainLossWavelengthGrid(), OptAmplifier::ReadSignalCrossSection(), ReceiverSemiAnalytical::ReceiverSemiAnalytical(), ReceiverSubsystem::ReceiverSubsystemInit(), ReceiverSubsystem::ReceiveSignalBackToBack(), ReceiverSemiAnalytical::ReceiveSignalBackToBackMonteCarlo(), ReduLumpedLoss::ReduLumpedLoss(), ReduOptAmplifier::ReduOptAmplifier(), ReduOptFiber::ReduOptFiber(), ReduPolarizTransformer::ReduPolarizTransformer(), SaturableAbsorber::SaturableAbsorber(), ElecFilter::Set_f_3dB_ElecFilter(), ElecFilter::SetFreqFWHM_ElecFilter(), OptFilter::SetFreqFWHM_OptFilter(), OptFiber::SetFstOrDispFiber(), RamanAmp::SetGainProfile(), OptFiber::SetGammaFiber(), Histogram2D::SetMaxY(), ElecSignalStat::SetOptElecFiltersForGaussianStatistics(), OptFiber::SetSndOrDispFiber(), RamanAmp::WriteCentralWavelength(), RamanAmp::WriteEqIntgData(), Histogram2D::WriteEyeDiagramHistogram(), Histogram2D::WriteFile_pdf2D(), RamanAmp::WriteGainShapeData(), ReduOptAmplifier::WriteSteadyInputPowerVersusOutputPower(), ReduOptAmplifier::WriteSteadyStateGainVersusPower(), and OptAmplifier::WriteSteadyStateGainVersusPower().

void LogFileStars (  ) 

Referenced by OptSignal::ConstructOptSignal(), MissingParameter(), ReadDouble(), ReadInt(), ReadLongInt(), ReadUnsignedInt(), ReadVectorOfDoubles(), and WrongTypeParameter().

void MissingParameter ( string  ParameterName,
InputParameterOptionsEnumerator  InputParameterOption,
bool  DebugLevel 
)

References LogFile, LogFileStars(), MANDATORY, OPTIONAL_NO_WARNING, and OPTIONAL_WARNING.

void MissingParameter ( string  ParameterName,
InputParameterOptionsEnumerator  InputParameterOption 
)

Referenced by MissingParameter(), ReadDouble(), ReadInt(), ReadLongInt(), ReadString(), ReadUnsignedInt(), and ReadVectorOfDoubles().

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

Referenced by ChiSquareReceiver::ChiSquareReceiver(), OptSignal::ConstructOptSignal(), ElecFilter::ElecFilter(), ElecSignalStat::ElecSignalStat(), GaussianReceiver::GaussianReceiver(), Histogram2D::Histogram2D(), PostDispCompSubSystem::InitApril2003(), Histogram::InitHistogram(), LumpedLoss::LumpedLoss(), MachZehnder::MachZehnder(), NoiseCovariance::NoiseCovariance(), OptAmplifier::OptAmplifier(), OptDataWriter::OptDataWriter(), OptFiber::OptFiber(), OptFiberLocalError::OptFiberLocalError(), OptFilter::OptFilter(), OptSpectrumAnalyzer::OptSpectrumAnalyzer(), Photodetector::Photodetector(), PolDepAttenuator::PolDepAttenuator(), PostDispCompSubSystem::PostDispCompSubSystem(), RamanAmp::PrepareSignalNonFourier(), ReduOptSignal::ProcessReduOptSignalParameters(), PulseEvolutionAnalyzer::PulseEvolutionAnalyzer(), RamanAmp::RamanAmp(), ReadDouble(), ElecFilter::ReadElecGain(), OptAmplifier::ReadGainProfile(), RamanAmp::ReadRamanGainLossWavelengthGrid(), ReduLumpedLoss::ReduLumpedLoss(), ReduOptAmplifier::ReduOptAmplifier(), ReduOptFiber::ReduOptFiber(), ReduOptSignal::ReduOptSignal(), SaturableAbsorber::SaturableAbsorber(), RamanAmp::SetGainProfile(), ReduOptSignal::SetOptElecFilterBandwidth(), and RamanAmp::WriteGainShapeData().

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

References cerror(), LogFile, LogFileStars(), LOWER_AND_UPPER, LOWER_ONLY, MissingParameter(), NO_BOUNDS, and UPPER_ONLY.

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

References cerror(), LogFile, LogFileStars(), LOWER_AND_UPPER, LOWER_ONLY, NO_BOUNDS, and UPPER_ONLY.

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

References cerror(), LogFile, LogFileStars(), LOWER_AND_UPPER, LOWER_ONLY, MissingParameter(), NO_BOUNDS, and UPPER_ONLY.

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

Referenced by BitString::BitString(), ChiSquareReceiver::ChiSquareReceiver(), OptSignal::ConstructOptSignal(), ElecFilter::ElecFilter(), ElecSignalStat::ElecSignalStat(), GaussianReceiver::GaussianReceiver(), OptSignal::GenerateSignalStringUsingInputSequence(), Histogram2D::Histogram2D(), PostDispCompSubSystem::InitApril2003(), ElecEqualizer::InitElecEqualizer(), Histogram::InitHistogram(), MachZehnder::MachZehnder(), NoiseCovariance::NoiseCovariance(), OptAmplifier::OptAmplifier(), OptDataWriter::OptDataWriter(), OptFiber::OptFiber(), OptFiberLocalError::OptFiberLocalError(), OptFilter::OptFilter(), OptSpectrumAnalyzer::OptSpectrumAnalyzer(), Photodetector::Photodetector(), PostDispCompSubSystem::PostDispCompSubSystem(), ReduOptSignal::ProcessReduOptSignalParameters(), RamanAmp::RamanAmp(), RanNumGen::RanNumGen(), OptAmplifier::ReadGainPowerDependent(), OptAmplifier::ReadGainProfile(), ReadInt(), ReduOptAmplifier::ReduOptAmplifier(), ReduOptFiber::ReduOptFiber(), ReduOptSignal::ReduOptSignal(), SaturableAbsorber::SaturableAbsorber(), and RamanAmp::SetGainProfile().

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

References cerror(), LogFile, LogFileStars(), LOWER_AND_UPPER, LOWER_ONLY, MissingParameter(), NO_BOUNDS, and UPPER_ONLY.

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

References cerror(), LogFile, LogFileStars(), LOWER_AND_UPPER, LOWER_ONLY, NO_BOUNDS, and UPPER_ONLY.

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

References cerror(), LogFile, LogFileStars(), LOWER_AND_UPPER, LOWER_ONLY, MissingParameter(), NO_BOUNDS, and UPPER_ONLY.

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

References cerror(), LogFile, LogFileStars(), LOWER_AND_UPPER, LOWER_ONLY, MissingParameter(), NO_BOUNDS, and UPPER_ONLY.

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

References cerror(), LogFile, LogFileStars(), LOWER_AND_UPPER, LOWER_ONLY, NO_BOUNDS, and UPPER_ONLY.

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

References ReadLongInt().

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

References cerror(), LogFile, LogFileStars(), LOWER_AND_UPPER, LOWER_ONLY, MissingParameter(), NO_BOUNDS, and UPPER_ONLY.

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

References ReadLongInt().

Referenced by RanNumGen::RanNumGen(), and ReadLongInt().

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

References LogFile, and MissingParameter().

string ReadString ( string  ParameterName,
ifstream *  InFile,
bool  DebugLevel 
)

References LogFile.

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

References LogFile, and MissingParameter().

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

Referenced by ChiSquareReceiver::ChiSquareReceiver(), OptSignal::ConstructOptSignal(), ElecFilter::ElecFilter(), Histogram::InitHistogram(), ReadString(), and ReduOptSignal::ReduOptSignal().

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

References ReadUnsignedInt().

Referenced by ReadUnsignedInt().

unsigned ReadUnsignedInt ( string  ParameterName,
string  UnitsString,
unsigned  LowerBound,
unsigned  UpperBound,
BoundsFlagEnumerator  BoundsFlag,
InputParameterOptionsEnumerator  InputParameterOption,
unsigned  DefaultValue,
ifstream *  InFile,
bool  DebugLevel 
)

References cerror(), LogFile, LogFileStars(), LOWER_AND_UPPER, LOWER_ONLY, MissingParameter(), NO_BOUNDS, and UPPER_ONLY.

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

References ReadVectorOfDoubles().

Referenced by ReadVectorOfDoubles().

double* ReadVectorOfDoubles ( string  ParameterName,
string  UnitsString,
double  LowerBound,
double  UpperBound,
BoundsFlagEnumerator  BoundsFlag,
InputParameterOptionsEnumerator  InputParameterOption,
double  DefaultValue,
unsigned  NumberOfElements,
ifstream *  InFile,
bool  DebugLevel 
)

References cerror(), LogFile, LogFileStars(), LOWER_AND_UPPER, LOWER_ONLY, MissingParameter(), NO_BOUNDS, UPPER_ONLY, and WrongTypeParameter().

string WriteTypeSimulation ( typeSimulation  TypeSimulation  ) 

References SCALAR, and VECTOR.

Referenced by OptSignal::ConstructOptSignal(), and LumpedLoss::InitLumpedLoss().

void WrongTypeParameter ( string  ParameterName  ) 

References WrongTypeParameter().

Referenced by ReadVectorOfDoubles(), and WrongTypeParameter().

void WrongTypeParameter ( string  ParameterName,
bool  DebugLevel 
)

References LogFile, and LogFileStars().

Variable Documentation

ofstream* LogFile
Generated on Fri Jul 2 2010 12:57:48 for OCS by  doxygen 1.7.1