ExampleProgramComLine Class Reference

The ComLineObject for the example programs. More...

#include <ExampleProgram.H>

Inheritance diagram for ExampleProgramComLine:

Collaboration diagram for ExampleProgramComLine:

Public Member Functions
	ExampleProgramComLine ()
	ExampleProgramComLine (const char *args[])
void	Initialize ()
	This is where the actual options and arguments are described. More...

Detailed Description

The ComLineObject for the example programs.

This comline object implements a basic command-line interface handler for the example programs. These command-line objects handle all of the generation of help messages, command line argument validation, and encapsulation.

Definition at line 72 of file ExampleProgram.H.

Constructor & Destructor Documentation

ExampleProgramComLine ( )

inline

Definition at line 75 of file ExampleProgram.H.

        : IRAD::Util::ComLineObject()
      {};

ExampleProgramComLine ( const char *  args[] )

inline

Definition at line 78 of file ExampleProgram.H.

        : IRAD::Util::ComLineObject(args)
      {};

Member Function Documentation

void Initialize ( )

inline

This is where the actual options and arguments are described.

For details about what can be done in this function, see the documentation for the IRAD::Util::ComLineObject.

Definition at line 87 of file ExampleProgram.H.

                       {
        AddOption('h',"help");
        AddOption('v',"verbosity",1);
        AddOption('o',"output",2,"filename");
        AddArgument("input",1);
        AddHelp("help","Prints this long version of help.");
        AddHelp("output","Specifies the name of the output file.");
        std::ostringstream Ostr;
        Ostr << "Mode-dependent input: Input <filename> for serial example"
             << "\n\t\tprogram, or <number of divisions> for parallel example.";
        AddArgHelp("input",Ostr.str());
        // The following commented string formation is kept around to 
        // illustrate the required tabs and newlines to make the output 
        // look proper:
        //
        //    Ostr << "Use fixed problem size in scalability analysis.  Only makes"
        //         << "\n\t\tsense when scalability mode is enabled.";
        //    Ostr.str("");
        Ostr.str("");
        Ostr << "Example GridConversion program.";
        _description.assign(Ostr.str());
      };

---

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

• ExampleProgram.H