PlasCom2  1.0
XPACC Multi-physics simluation application
TestComLine Class Reference

ComLineObject for testing app. More...

Detailed Description

ComLineObject for testing app.

Definition at line 18 of file QuickTest.C.

Public Member Functions

 TestComLine ()
 
 TestComLine (const char *args[])
 
void Initialize ()
 virtual function for program specific Initialization. More...
 
- Public Member Functions inherited from ComLineObject
 ComLineObject ()
 Default constructor. More...
 
 ComLineObject (const char *args[])
 Constructor. More...
 
 ComLineObject (ComLineObject &incom)
 Copy constructor. More...
 
void Copy (ComLineObject &incom)
 Copy method. More...
 
int ProcessCommandLine (const char *args[])
 One fell swoop processing of command line. More...
 
std::string GetRawComLine () const
 Raw Command Line Access. More...
 
void SetRawComLine (const std::string &incl)
 Raw Command Line Access. More...
 
int ProcessOptions ()
 Processes all command line tokens. More...
 
void Record (const char *args[])
 Minimal recording of command line. More...
 
void AddOption (char s, const std::string &l, int=0)
 User interface to describe simple option. More...
 
void AddOption (char s, const std::string &l, int, const std::string argname)
 User interface to describe option with argument. More...
 
void AddArgument (const std::string &a, int reqd=0)
 User interface to describe an application argument. More...
 
void AddArgHelp (const std::string &a, const std::string &help)
 Specify the usage info for application argument. More...
 
void SetArgName (const std::string opstr, const std::string argname)
 Specify name of an option argument. More...
 
void SetArgName (char s, const std::string &argname)
 Specify name of an option argument. More...
 
void AddHelp (char s, const std::string &help)
 Specify usage for an option. More...
 
void AddHelp (const std::string &l, const std::string &help)
 Specify usage for an option. More...
 
std::string GetOpStringByType (int mintype, int maxtype)
 Obtains option strings by type. More...
 
std::string GetHelp (char s)
 Obtain the usage string for an option. More...
 
std::string GetHelp (const std::string &l)
 Obtain the usage string for an option. More...
 
char GetShort (const std::string &l)
 Obtain the short one char option from the long word version. More...
 
std::string GetLong (const char &s)
 Obtain the long word option from the short char version. More...
 
std::string ShortUsage ()
 Generate short usage string. More...
 
std::string LongUsage ()
 Generate long usage string. More...
 
std::string GetOption (const char &s)
 Get the value of an option. More...
 
std::string GetOption (const std::string &l)
 Get the value of an option. More...
 
std::string ErrorReport ()
 Error reporting. More...
 
std::string ProgramName () const
 Program name access. More...
 
std::vector< std::string > GetArgs () const
 Argument access. More...
 
void SetDescription (const std::string &desc)
 Set description string. More...
 
void SetNotes (const std::string &notes)
 Set notes string. More...
 
void WriteRC (std::ostream &Ostr) const
 Write an RC string that can be used for config. More...
 
void ReadRC (const std::string &RCString)
 Read a config from RC string. More...
 
template<typename NumType >
void ProcessRange (NumType &t1, NumType &t2, const std::string stinter)
 Process a range in the format "t1:t2". More...
 
template<typename NumType >
void ResolveOption (NumType &t2, const std::string stinter)
 Resolve an option (i.e. More...
 
virtual void UserInitialize (void)
 virtual function for program specific Initialization. More...
 
virtual ~ComLineObject ()
 

Additional Inherited Members

- Protected Attributes inherited from ComLineObject
std::string _description
 application description. More...
 
std::string _notes
 Notes to be displayed at the end of LongUsage(). More...
 
std::string _program_name
 the name of the program More...
 
std::string _line
 unformatted command line More...
 
std::vector< std::string > _error_messages
 stores error messages More...
 
std::vector< std::string > _nonops
 stores non-option arguments More...
 
std::map< char, std::string > _options
 stores the value of each option More...
 
std::map< char, std::string > _help
 stores the help string for each op More...
 
std::map< char, std::string > _argname
 stores a name for arguments More...
 
std::map< char, int > _type
 stores the type of option More...
 
std::vector< std::pair< std::string, int > > _args
 application arguments; More...
 
std::map< std::string, std::string > _arghelp
 help string for args More...
 
std::vector< std::string > _toks
 commandline tokens More...
 
Inheritance diagram for TestComLine:
Collaboration diagram for TestComLine:

Constructor & Destructor Documentation

◆ TestComLine() [1/2]

TestComLine ( )
inline

Definition at line 21 of file QuickTest.C.

◆ TestComLine() [2/2]

TestComLine ( const char *  args[])
inline

Definition at line 24 of file QuickTest.C.

Member Function Documentation

◆ Initialize()

void Initialize ( void  )
inlinevirtual

virtual function for program specific Initialization.

Reimplemented from ComLineObject.

Definition at line 27 of file QuickTest.C.

References ComLineObject::_description, ComLineObject::AddArgHelp(), ComLineObject::AddArgument(), ComLineObject::AddHelp(), and ComLineObject::AddOption().

Here is the call graph for this function:

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