Gromacs  2026.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/mdrun/binary_information.h>

Description

Settings for printBinaryInformation().

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

Public Member Functions

BinaryInformationSettings & extendedInfo (bool bEnabled)
 Set whether to print information about build settings.
 
BinaryInformationSettings & copyright (bool bEnabled)
 Set whether to print copyright and license information.
 
BinaryInformationSettings & processId (bool bEnabled)
 Set whether to print the process ID.
 
BinaryInformationSettings & generatedByHeader (bool bEnabled)
 Set whether to print a header line with "Generated by" text (for output files).
 
BinaryInformationSettings & linePrefix (const char *prefix)
 Prefix each line with this string.
 
BinaryInformationSettings & lineSuffix (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: