SSAGES::EventListener Class Reference

Base abstract class for listening in to events fired by "Hook". More...

#include <EventListener.h>

Inheritance diagram for SSAGES::EventListener:

Public Member Functions
	EventListener (uint frequency)
	Constructor. More...
uint	GetFrequency () const
	Get frequency of event listener. More...
virtual void	PreSimulation (Snapshot *snapshot, const class CVManager &cvmanager)=0
	Method call prior to simulation initiation. More...
virtual void	PostIntegration (Snapshot *snapshot, const class CVManager &cvmanager)=0
	Method call post integration. More...
virtual void	PostSimulation (Snapshot *snapshot, const class CVManager &cvmanager)=0
	Method call post simulation. More...
virtual	~EventListener ()
	Destructor.

Private Attributes
uint	frequency_
	Frequency for listening.

Detailed Description

Base abstract class for listening in to events fired by "Hook".

Definition at line 34 of file EventListener.h.

Constructor & Destructor Documentation

SSAGES::EventListener::EventListener ( uint  frequency )

inline

Constructor.

Parameters

frequency

Frequency for listening.

Definition at line 44 of file EventListener.h.

                                      : 
        frequency_(frequency)
        {
        }

Member Function Documentation

uint SSAGES::EventListener::GetFrequency ( ) const

inline

Get frequency of event listener.

Returns

Frequency of event listener.

Definition at line 53 of file EventListener.h.

References frequency_.

{ return frequency_; }

virtual void SSAGES::EventListener::PostIntegration ( Snapshot *  snapshot, const class CVManager &  cvmanager  )

pure virtual

Method call post integration.

Parameters

snapshot	Pointer to the simulation snapshot.
cvmanager	Collective variable manager.

This function will be called at the end of each integration step.

Implemented in SSAGES::ForwardFlux, SSAGES::Basis, SSAGES::ABF, SSAGES::StringMethod, SSAGES::Meta, SSAGES::Umbrella, SSAGES::Swarm, SSAGES::FiniteTempString, SSAGES::ElasticBand, SSAGES::Logger, SSAGES::Method, and SSAGES::DirectForwardFlux.

virtual void SSAGES::EventListener::PostSimulation ( Snapshot *  snapshot, const class CVManager &  cvmanager  )

pure virtual

Method call post simulation.

Parameters

snapshot	Pointer to the simulation snapshot.
cvmanager	Collective variable manager.

This function will be called after the simulation has finished.

Implemented in SSAGES::ForwardFlux, SSAGES::Basis, SSAGES::ABF, SSAGES::StringMethod, SSAGES::Meta, SSAGES::Umbrella, SSAGES::Logger, and SSAGES::Method.

virtual void SSAGES::EventListener::PreSimulation ( Snapshot *  snapshot, const class CVManager &  cvmanager  )

pure virtual

Method call prior to simulation initiation.

Parameters

snapshot	Pointer to the simulation snapshot.
cvmanager	Collective variable manager.

This function will be called before the simulation is started.

Implemented in SSAGES::ForwardFlux, SSAGES::Basis, SSAGES::ABF, SSAGES::StringMethod, SSAGES::Meta, SSAGES::Umbrella, SSAGES::Logger, and SSAGES::Method.

---

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

• /home/cody/SSAGES/src/EventListener.h