PROFASI  Version 1.5
Public Member Functions | List of all members
prf_utils::OptBase Class Reference

Base class for program switches and options.

#include <ProgUtils.hh>

Inheritance diagram for prf_utils::OptBase:
Inheritance graph

Public Member Functions

void Name (std::string st)
 Set a name for an option created with the default constructor.
std::string Name () const
 Retrieve the option name.
std::string LongName () const
 Retrieve long name.
void LongName (std::string st)
 Set a long name.
std::string short_help () const
 Retrieve short help-text/info.
void short_help (std::string st)
 Set short help text.
std::string help () const
 Help text.
void set_help_text (std::string st)
 Set help text.
void append_help_text (std::string st)
 Append to existing help text.
void set_given ()
 Activate the option.
bool state () const
 Is the option active ?

Member Function Documentation

void prf_utils::OptBase::set_given ( )

Just because a program accepts 15 options does not mean that one would need to specify all of them every time one runs it! So, an option is created inactive. Only when the user specifies it on does one "activate" it. Activated or not- activated describes states of an option. But the flag is not used in this class for any internal purpose.

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

PROFASI: Protein Folding and Aggregation Simulator, Version 1.5
© (2005-2016) Anders Irbäck and Sandipan Mohanty
Documentation generated on Mon Jul 18 2016 using Doxygen version 1.8.2