gmx::LoggingSignaller Class Reference

#include <gromacs/modularsimulator/signallers.h>

Inheritance diagram for gmx::LoggingSignaller:

Collaboration diagram for gmx::LoggingSignaller:

Description

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.

Friends
class	SignallerBuilder< LoggingSignaller >
	Allow builder to construct.

Additional Inherited Members

Member Function Documentation

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

overridevirtual

Run the signaller at a specific step / time.

Informs callbacks if step % nstlog_ == 0

Parameters

step	The current time step
time	The current time

Implements gmx::ISignaller.

---

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

• src/gromacs/modularsimulator/signallers.h
• src/gromacs/modularsimulator/signallers.cpp