Gromacs  2021-beta2-UNCHECKED
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Friends
gmx::LoggingSignaller Class Referencefinal

#include <gromacs/modularsimulator/signallers.h>

+ Inheritance diagram for gmx::LoggingSignaller:
+ Collaboration diagram for gmx::LoggingSignaller:


Element signalling a logging step.

This element informs its clients via callbacks when a logging step is happening.

Public Types

typedef ILoggingSignallerClient Client
 Define client type.

Public Member Functions

void signal (Step step, Time time) override
 Run the signaller at a specific step / time. More...
void setup () override
 Check that necessary registration was done.
- Public Member Functions inherited from gmx::ISignaller
virtual ~ISignaller ()=default
 Standard virtual destructor.
- Public Member Functions inherited from gmx::ILastStepSignallerClient
virtual ~ILastStepSignallerClient ()=default
 Standard virtual destructor.


class SignallerBuilder< LoggingSignaller >
 Allow builder to construct.

Additional Inherited Members

Member Function Documentation

void gmx::LoggingSignaller::signal ( Step  step,
Time  time 

Run the signaller at a specific step / time.

Informs callbacks if step % nstlog_ == 0

stepThe current time step
timeThe current time

Implements gmx::ISignaller.

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