Gromacs  2025-dev-20240906-b7d3419
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions
gmx::ITrajectoryWriterClient Class Referenceabstract

#include <gromacs/modularsimulator/modularsimulatorinterfaces.h>

+ Inheritance diagram for gmx::ITrajectoryWriterClient:

Description

Interface for writer clients of the TrajectoryElement.

Defining registerTrajectoryWriterCallback allows clients to register an arbitrary callback called by the TrajectoryElement when trajectory writing happens.

Setup and teardown methods allow clients to perform tasks with a valid output pointer.

Public Member Functions

virtual ~ITrajectoryWriterClient ()=default
 Standard virtual destructor.
 

Protected Member Functions

virtual void trajectoryWriterSetup (gmx_mdoutf *outf)=0
 Setup method with valid output pointer.
 
virtual void trajectoryWriterTeardown (gmx_mdoutf *outf)=0
 Teardown method with valid output pointer.
 
virtual std::optional
< ITrajectoryWriterCallback
registerTrajectoryWriterCallback (TrajectoryEvent)=0
 Return callback to TrajectoryElement.
 

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