SSAGES  0.1
A MetaDynamics Package
Public Member Functions | Private Attributes | List of all members
SSAGES::EventListener Class Referenceabstract

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

#include <EventListener.h>

Inheritance diagram for SSAGES::EventListener:
Inheritance graph
[legend]

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
frequencyFrequency for listening.

Definition at line 44 of file EventListener.h.

44  :
45  frequency_(frequency)
46  {
47  }
uint frequency_
Frequency for listening.
Definition: EventListener.h:37

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_, PostIntegration(), PostSimulation(), and PreSimulation().

53 { return frequency_; }
uint frequency_
Frequency for listening.
Definition: EventListener.h:37

Here is the call graph for this function:

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

Method call post integration.

Parameters
snapshotPointer to the simulation snapshot.
cvmanagerCollective variable manager.

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

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

Referenced by GetFrequency().

Here is the caller graph for this function:

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

Method call post simulation.

Parameters
snapshotPointer to the simulation snapshot.
cvmanagerCollective variable manager.

This function will be called after the simulation has finished.

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

Referenced by GetFrequency().

Here is the caller graph for this function:

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

Method call prior to simulation initiation.

Parameters
snapshotPointer to the simulation snapshot.
cvmanagerCollective variable manager.

This function will be called before the simulation is started.

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

Referenced by GetFrequency().

Here is the caller graph for this function:


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