CYCLUS
Public Member Functions | List of all members
cyclus::TimeListener Class Referenceabstract

Detailed Description

The TimeListener class is an inheritable class for any Agent that requires knowlege of ticks and tocks.

The agent should register as a TimeListener with its context from its Deploy method. For Example:

MyFacility::Build(cyclus::Agent* parent) {
context()->RegisterTimeListener(this);
}

Definition at line 23 of file time_listener.h.

#include <time_listener.h>

Inheritance diagram for cyclus::TimeListener:
cyclus::Ider cyclus::Facility cyclus::Institution cyclus::Region cyclus::Dummy

Public Member Functions

virtual void Tick ()=0
 
virtual void Tock ()=0
 
- Public Member Functions inherited from cyclus::Ider
virtual const int id () const =0
 

Member Function Documentation

virtual void cyclus::TimeListener::Tick ( )
pure virtual

Simulation agents do their beginning-of-timestep activities in the Tick method.

Parameters
timeis the current simulation timestep

Implemented in cyclus::Region, and cyclus::Institution.

virtual void cyclus::TimeListener::Tock ( )
pure virtual

Simulation agents do their end-of-timestep activities in the Tock method.

Parameters
timeis the current simulation timestep

Implemented in cyclus::Region, and cyclus::Institution.


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