Gromacs  2024.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions
gmx::SignallerBuilder< Signaller > Class Template Reference

#include <gromacs/modularsimulator/signallers.h>


template<class Signaller>
class gmx::SignallerBuilder< Signaller >

Builder for signallers.

This builder allows clients to register, and then builds the signaller passing on the list of clients.

Template Parameters
SignallerThe signaller to be built

Public Member Functions

void registerSignallerClient (typename Signaller::Client *client)
 Allows clients to register to the signaller.
template<typename... Args>
std::unique_ptr< Signaller > build (Args &&...args)
 Build the signaller. More...
< TrajectorySignaller
build (Args &&...args)
std::unique_ptr< EnergySignallerbuild (Args &&...args)

Member Function Documentation

template<class Signaller >
template<typename... Args>
std::unique_ptr< Signaller > gmx::SignallerBuilder< Signaller >::build ( Args &&...  args)

Build the signaller.

General version - for NeighborSearchSignaller, LastStepSignaller, LoggingSignaller

std::unique_ptr< TrajectorySignaller > gmx::SignallerBuilder< TrajectorySignaller >::build ( Args &&...  args)

Specialized version - TrajectorySignaller has a different build process

std::unique_ptr< EnergySignaller > gmx::SignallerBuilder< EnergySignaller >::build ( Args &&...  args)

Specialized version - EnergySignaller has a significantly different build process

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