votca::csg::CGObserver Class Reference

Observer class for analysis hook. More...

#include <cgobserver.h>

Inheritance diagram for votca::csg::CGObserver:

Public Member Functions
virtual void	BeginCG (Topology *top, Topology *top_atom=nullptr)=0
	called before the first frame
virtual void	EndCG ()=0
	called after the last frame
virtual void	EvalConfiguration (Topology *top, Topology *top_atom=nullptr)=0

Detailed Description

Observer class for analysis hook.

Each application which performs analysis operations should use CGEngine. It offers a hook (callback class) during the coarse-graining process to evaluate each frame. The user does not have to take care about mapping and other stuff. Just overload this class and analyze properties of interest.

Definition at line 36 of file cgobserver.h.

Member Function Documentation

BeginCG()

virtual void votca::csg::CGObserver::BeginCG ( Topology *  top, Topology *  top_atom = nullptr  )

pure virtual

called before the first frame

Implemented in votca::csg::BondedStatistics.

EndCG()

virtual void votca::csg::CGObserver::EndCG ( )

pure virtual

called after the last frame

Implemented in votca::csg::BondedStatistics.

EvalConfiguration()

virtual void votca::csg::CGObserver::EvalConfiguration ( Topology *  top, Topology *  top_atom = nullptr  )

pure virtual

Implemented in votca::csg::BondedStatistics.

---

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

• csg/include/votca/csg/cgobserver.h