Implementation of the basic parts of the serial program example. More...

#include <ExampleProgram.H>

Inheritance diagram for SerialProgram:

Collaboration diagram for SerialProgram:

Public Member Functions
	SerialProgram ()
	Default constructor. More...

	SerialProgram (int nargs, char **args)
	Constructor designed to take the commandline args. More...

virtual int	Initialize ()
	Initializes native data structures from commandline args. More...

int	VerbLevel () const
	Returns verbosity level. More...

virtual	~SerialProgram ()
	Destructor. More...

virtual int	Run ()
	This function implements the main function executed by the program. More...

Protected Attributes
std::string	output_name
	Name of file for output. More...

std::string	input_name
	Name of input file. More...

int	verblevel
	Verbosity level. More...

std::ofstream	Ouf
	Outfile stream for output. More...

std::ifstream	Inf
	Infile stream for input. More...

Detailed Description

Implementation of the basic parts of the serial program example.

This object encapsulates the example serial program. It inherits from the IRAD::Global::Program type.

The program itself just copies a specified input file to the specified output file (or stdout if no file is given). The command line usage goes:

       sep Usage:

       sep [-h] [-v [arg] -o <filename> ] <input> 

       -h,--help
          Prints this long version of help.

              -v,--verbosity [arg]

       -o,--output <filename>
          Specifies the name of the output file.

              <input>
          Mode-dependent input: input <filename> for serial example
          program, or <number of divisions> for parallel example.

Definition at line 158 of file ExampleProgram.H.

Constructor & Destructor Documentation

SerialProgram ( )

inline

Default constructor.

Definition at line 175 of file ExampleProgram.H.

                       :
         SerialProgramType()
       {};

SerialProgram	(	int	nargs,
		char **	args
	)

inline

Constructor designed to take the commandline args.

Definition at line 181 of file ExampleProgram.H.

                                            :
         SerialProgramType(nargs,args)
       {};

virtual ~SerialProgram ( )

inlinevirtual

Destructor.

Definition at line 243 of file ExampleProgram.H.

References SerialProgram::Ouf.

                                {
         if(Ouf){
           Ouf.close();
           SetOutStream(std::cout);
         }
       };

Member Function Documentation

virtual int Initialize ( )

inlinevirtual

Initializes native data structures from commandline args.

Definition at line 187 of file ExampleProgram.H.

References SerialProgram::input_name, SerialProgram::output_name, and SerialProgram::verblevel.

       {
         int retval = SerialProgramType::Initialize();
         if(!_command_line.GetOption("help").empty()){
           std::ostringstream Ostr;
           Ostr << _command_line.LongUsage() << std::endl;
           StdOut(Ostr.str());
           return(-1);
         }
         if(retval){
           std::ostringstream Ostr;
           Ostr << _command_line.ErrorReport() << std::endl
                << std::endl << _command_line.ShortUsage() << std::endl;
           ErrOut(Ostr.str());
           return(retval);
         }
 
         // Check if output file is specified
         output_name = _command_line.GetOption("output");
 
         // Set input file to first argument
         std::vector<std::string> args(_command_line.GetArgs());
         input_name = args[0];
 
         // Check the verbosity level
         std::string sverb(_command_line.GetOption("verbosity"));
         if(sverb.empty() || sverb == ".true.")
           verblevel = 1;
         else {
           std::istringstream Vin(sverb);
           Vin >> verblevel;
           if(verblevel < 0)
             verblevel = 1;
         }
 
         // If high verbosity, stick a configuration blurb to stdout.
         if(verblevel > 1){
           std::ostringstream Ostr;
           Ostr << "Configuration:" << std::endl
                << "verbosity           = " << verblevel << std::endl
                << "input_name          = " << input_name << std::endl;
           if(!output_name.empty())
             Ostr << "output file         = " << output_name << std::endl;
           Ostr << std::endl;
           StdOut(Ostr.str());
         } 
 
         return(0);
       };

int Run ( )

virtual

This function implements the main function executed by the program.

Definition at line 16 of file ExampleSerialProgram.C.

References SerialProgram::Inf, SerialProgram::input_name, SerialProgram::Ouf, and SerialProgram::output_name.

     {
       // FunctionEntry("NAME"): Updates the user-defined stack and 
       // the program profiles with timing information. The placement
       // of FunctionEntry and FunctionExit calls is at the developer's
       // discretion.  
       FunctionEntry("Run");
 
       // ---------- The Program -----------------
       // This program just "copies" the input file
       // to the output file.
       //
 
       // Open the specified input file for reading
       Inf.open(input_name.c_str());
       if(!Inf){
         // If the input file failed to open, notify to
         // the error stream and return non-zero
         std::ostringstream Ostr;
         Ostr << "Error: Could not open input file, '" 
              << input_name << "'.\n";
         ErrOut(Ostr.str());
         // don't forget to tell the profiler/stacker the
         // function is exiting.
         FunctionExit("Run");
         return(1);
       }
 
       // Open the specified output file for writing
       bool use_outfile = false;
       if(!output_name.empty()){
         use_outfile = true;
         Ouf.open(output_name.c_str());
         if(!Ouf){
           // If the output file failed to open, notify
           // to error stream and return non-zero
           std::ostringstream Ostr;
           Ostr << "Error: Unable to open output file, " << output_name << ".";
           ErrOut(Ostr.str());
           // don't forget to tell the profiler/stacker the
           // function is exiting.
           FunctionExit("Run");
           return(1);
         }
       }
 
       // Read lines from the input file and repeat them 
       // to the output file.
       std::string line;
       while(std::getline(Inf,line)){
         if(use_outfile)
           Ouf << line << std::endl;
         else
           StdOut(line+"\n");
       }
       // Close both files
       Ouf.close();
       Inf.close();
       
       //
       // ---------- Program End -----------------
 
 
       // Update the stacker/profiler that we are exiting 
       // this function.
       FunctionExit("Run");
       // return 0 for success
       return(0);
     };