Gromacs  2020.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions
gmx::CommandLineCommonOptionsHolder Class Reference

#include <gromacs/commandline/cmdlinemodulemanager_impl.h>

Description

Encapsulates some handling of common options to the wrapper binary.

Public Member Functions

void initOptions ()
 Initializes the common options.
 
bool finishOptions ()
 Finishes option parsing. More...
 
void adjustFromSettings (const CommandLineModuleSettings &settings)
 Adjust defaults based on module settings.
 
Optionsoptions ()
 Returns the internal Options object.
 
const BinaryInformationSettingsbinaryInfoSettings () const
 Returns the settings for printing startup information.
 
bool shouldIgnoreActualModule () const
 Returns true if common options are set such that the wrapper binary should quit, without running the actual module.
 
bool shouldShowHelp () const
 Returns whether common options specify showing help.
 
bool shouldShowHidden () const
 Returns whether common options specify showing hidden options in help.
 
bool shouldBeQuiet () const
 Returns whether common options specify quiet execution.
 
bool shouldBackup () const
 Returns whether backups should be made.
 
int niceLevel () const
 Returns the nice level.
 
bool enableFPExceptions () const
 Returns whether floating-point exception should be enabled.
 
int debugLevel () const
 Returns the debug level.
 
FILE * startupInfoFile () const
 Returns the file to which startup information should be printed.
 

Member Function Documentation

bool gmx::CommandLineCommonOptionsHolder::finishOptions ( )

Finishes option parsing.

Returns
false if the wrapper binary should quit without executing any module.

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