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

#include <gromacs/commandline/cmdlinemodulemanager.h>

Description

Handle to add content to a group added with CommandLineModuleManager::addModuleGroup().

This class only provides a public interface to construct a module group for CommandLineModuleManager, and has semantics similar to a pointer: copies all point to the same group. The actual state of the group is maintained in an internal implementation class.

Public Member Functions

void addModule (const char *name)
 Adds a module to this group. More...
 
void addModuleWithDescription (const char *name, const char *description)
 Adds a module to this group with a custom description. More...
 

Member Function Documentation

void gmx::CommandLineModuleGroup::addModule ( const char *  name)

Adds a module to this group.

Parameters
[in]nameName of the module.
Exceptions
std::bad_allocif out of memory.

This works as addModuleWithDescription(), but uses the short description of the module itself as the description.

See Also
addModuleWithDescription()
void gmx::CommandLineModuleGroup::addModuleWithDescription ( const char *  name,
const char *  description 
)

Adds a module to this group with a custom description.

Parameters
[in]nameName of the module.
[in]descriptionDescription of the module in this group.
Exceptions
std::bad_allocif out of memory.

name must name a module added into the CommandLineModuleManager. It is possible to add the same module into multiple groups.


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