kspaceFirstOrder3D-OMP 1.0
The C++ implementation of the k-wave toolbox for the time-domain simulation of acoustic wave fields in 3D
Public Member Functions | Protected Member Functions | Private Attributes | Static Private Attributes
TCommandLineParameters Class Reference

The class to parse and store command line parameters.

#include <CommandLineParameters.h>

Collaboration diagram for TCommandLineParameters:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 TCommandLineParameters ()
 Constructor.
virtual ~TCommandLineParameters ()
 Destructor.
std::string GetInputFileName () const
 Get input file name.
std::string GetOutputFileName () const
 Get output file name.
bool IsBenchmarkFlag () const
 Is --benchmark flag set?
bool IsVersion () const
 Is --version flag set.
int GetBenchmarkTimeStepsCount () const
 Get benchmark time step count.
int GetCompressionLevel () const
 Get compression level.
int GetNumberOfThreads () const
 Get number of threads.
int GetVerboseInterval () const
 Get verbose interval.
int GetStartTimeIndex () const
 Get start time index when sensor data collection begins.
bool IsStore_p_raw () const
 Is --p_raw set?
bool IsStore_p_rms () const
 Is --p_rms set?
bool IsStore_p_max () const
 Is --p_max set?
bool IsStore_p_final () const
 Is --p_final set?
bool IsStore_u_raw () const
 Is --u_raw set?
bool IsStore_u_rms () const
 Is --u_rms set?
bool IsStore_u_max () const
 Is --u_max set?
bool IsStore_u_final () const
 Is --u_final set?
bool IsStore_I_avg () const
 Is --I_avg set.
bool IsStore_I_max () const
 Is --I_max set.
void PrintUsageAndExit ()
 Print usage and exit.
void PrintSetup ()
 Print setup.
void ParseCommandLine (int argc, char **argv)
 Parse command line.

Protected Member Functions

 TCommandLineParameters (const TCommandLineParameters &src)
 Copy constructor not allowed for public.
TCommandLineParametersoperator= (const TCommandLineParameters &src)
 operator = not allowed for public

Private Attributes

std::string InputFileName
 Input file name.
std::string OutputFileName
 Output file name.
int NumberOfThreads
 NumberOfThreads value.
int VerboseInterval
 VerboseInterval value.
int CompressionLevel
 CompressionLevel value.
bool BenchmarkFlag
 BenchmarkFlag value.
int BenchmarkTimeStepsCount
 BenchmarkTimeStepsCount value.
bool PrintVersion
 PrintVersion value.
bool Store_p_raw
 Store_p_raw value.
bool Store_p_rms
 Store_p_rms value.
bool Store_p_max
 Store_p_max value.
bool Store_p_final
 Store_p_final value.
bool Store_u_raw
 Store_u_raw value.
bool Store_u_rms
 Store_u_rms value.
bool Store_u_max
 Store_u_max value.
bool Store_u_final
 Store_u_final value.
bool Store_I_avg
 Store_I_avg value.
bool Store_I_max
 Store_I_max value.
int StartTimeStep
 StartTimeStep value.

Static Private Attributes

static const int DefaultCompressionLevel = 3
 Default compression level.
static const int DefaultVerboseInterval = 5
 Default verbose interval.

Detailed Description

Definition at line 138 of file CommandLineParameters.h.


Constructor & Destructor Documentation

TCommandLineParameters::TCommandLineParameters ( )

Constructor

Definition at line 53 of file CommandLineParameters.cpp.


Member Function Documentation

void TCommandLineParameters::ParseCommandLine ( int  argc,
char **  argv 
)

Parse command line.

Parameters:
[in,out]argc
[in,out]argv

Definition at line 165 of file CommandLineParameters.cpp.

Here is the call graph for this function:


The documentation for this class was generated from the following files:
 All Classes Files Functions Variables Typedefs Enumerations