$extrastylesheet
Dakota  Version 6.2
Public Member Functions | Private Member Functions | Private Attributes
CommandLineHandler Class Reference

Utility class for managing command line inputs to DAKOTA. More...

Inheritance diagram for CommandLineHandler:
GetLongOpt

List of all members.

Public Member Functions

 CommandLineHandler ()
 default constructor, requires check_usage() call for parsing
 CommandLineHandler (int argc, char **argv, int world_rank)
 constructor with parsing
 ~CommandLineHandler ()
 destructor
void check_usage (int argc, char **argv)
 Verifies that DAKOTA is called with the correct command usage. Prints a descriptive message and exits the program if incorrect.
int read_restart_evals () const
 Returns the number of evaluations to be read from the restart file (as specified on the DAKOTA command line) as an integer instead of a const char*.
void usage (std::ostream &outfile=Cout) const
 Print usage information to outfile, conditionally on rank.

Private Member Functions

void initialize_options ()
 enrolls the supported command line inputs.
void output_helper (const std::string &message, std::ostream &os) const
 output only on Dakota worldRank 0 if possible

Private Attributes

int worldRank
 Rank of this process within Dakota's allocation; manages conditional output.

Detailed Description

Utility class for managing command line inputs to DAKOTA.

CommandLineHandler provides additional functionality that is specific to DAKOTA's needs for the definition and parsing of command line options. Inheritance is used to allow the class to have all the functionality of the base class, GetLongOpt.


Member Function Documentation

void output_helper ( const std::string &  message,
std::ostream &  os 
) const [private]

output only on Dakota worldRank 0 if possible

When there is a valid ParallelLibrary, output only on rank 0

References CommandLineHandler::worldRank.

Referenced by CommandLineHandler::check_usage().


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