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]	argc	Number of elements in argv.
[in]	argv	Command-line arguments.

Exceptions

unspecified

May throw exceptions to indicate errors.

Returns

Exit code for the program.

Return values

0	on 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]

context

Context object for writing the help.

Exceptions

std::bad_alloc	if out of memory.
FileIOError	on any I/O error.

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

Implements gmx::ICommandLineModule.

---

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

• src/programs/legacymodules.cpp