Gromacs  2020.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions
anonymous_namespace{legacymodules.cpp}::ObsoleteToolModule Class Reference
+ Inheritance diagram for anonymous_namespace{legacymodules.cpp}::ObsoleteToolModule:
+ Collaboration diagram for anonymous_namespace{legacymodules.cpp}::ObsoleteToolModule:

Description

Command line module that provides information about obsolescence.

Prints a message directing the user to a wiki page describing replacement options.

Public Member Functions

 ObsoleteToolModule (const char *name)
 Creates an obsolete tool module for a tool with the given name.
 
const char * name () const override
 Returns the name of the module.
 
const char * shortDescription () const override
 Returns a one-line description of the module.
 
void init (gmx::CommandLineModuleSettings *) override
 Initializes the module and provides settings for the runner. More...
 
int run (int, char *[]) override
 Runs the module with the given arguments. More...
 
void writeHelp (const gmx::CommandLineHelpContext &) const override
 Prints help for the module. More...
 

Member Function Documentation

void anonymous_namespace{legacymodules.cpp}::ObsoleteToolModule::init ( gmx::CommandLineModuleSettings settings)
inlineoverridevirtual

Initializes the module and provides settings for the runner.

This will be called before run(), and can be used to adjust initialization that the runner does.

This method is currently not called when writing the help.

Implements gmx::ICommandLineModule.

int anonymous_namespace{legacymodules.cpp}::ObsoleteToolModule::run ( int  argc,
char *  argv[] 
)
inlineoverridevirtual

Runs the module with the given arguments.

Parameters
[in]argcNumber of elements in argv.
[in]argvCommand-line arguments.
Exceptions
unspecifiedMay throw exceptions to indicate errors.
Returns
Exit code for the program.
Return values
0on successful termination.

argv[0] is the name of the module, i.e., the arguments are as if the module was run as a standalone executable.

Implements gmx::ICommandLineModule.

void anonymous_namespace{legacymodules.cpp}::ObsoleteToolModule::writeHelp ( const gmx::CommandLineHelpContext context) const
inlineoverridevirtual

Prints help for the module.

Parameters
[in]contextContext object for writing the help.
Exceptions
std::bad_allocif out of memory.
FileIOErroron any I/O error.

Note that for MPI-enabled builds, this is called only on the master rank.

Implements gmx::ICommandLineModule.


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