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

#include <gromacs/utility/binaryinformation.h>

Description

Settings for printBinaryInformation().

This class is used to specify what printBinaryInformation() prints.

Public Member Functions

BinaryInformationSettingsextendedInfo (bool bEnabled)
 Set whether to print information about build settings.
 
BinaryInformationSettingscopyright (bool bEnabled)
 Set whether to print copyright and license information.
 
BinaryInformationSettingsprocessId (bool bEnabled)
 Set whether to print the process ID.
 
BinaryInformationSettingsgeneratedByHeader (bool bEnabled)
 Set whether to print a header line with "Generated by" text (for output files).
 
BinaryInformationSettingslinePrefix (const char *prefix)
 Prefix each line with this string.
 
BinaryInformationSettingslineSuffix (const char *suffix)
 Suffix each line with this string.
 

Friends

void printBinaryInformation (TextWriter *writer, const IProgramContext &programContext, const BinaryInformationSettings &settings)
 Needed to read the members without otherwise unnecessary accessors. More...
 

Friends And Related Function Documentation

void printBinaryInformation ( TextWriter writer,
const IProgramContext programContext,
const BinaryInformationSettings settings 
)
friend

Needed to read the members without otherwise unnecessary accessors.

Parameters
[out]writerWhere to print the information.
[in]programContextProgram information object to use.
[in]settingsSpecifies what to print.
Exceptions
std::bad_allocif out of memory.
See Also
BinaryInformationSettings

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