cyclus::TimeListener Class Reference

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) {
  cyclus::Facility::Build(parent);
  context()->RegisterTimeListener(this);
}

Definition at line 23 of file time_listener.h.

#include <time_listener.h>

Inheritance diagram for cyclus::TimeListener:

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

Member Function Documentation

Decision()

virtual void cyclus::TimeListener::Decision ( )

inlinevirtual

Simulation agents do their end-of-timestep decisions in the Decision method.

The decision method allows for agents to make decision based on the operation of facilities during the tick and tock of the current timestep. Facility operations should not occur during this phase.

Parameters

time	is the current simulation timestep

Definition at line 44 of file time_listener.h.

Tick()

virtual void cyclus::TimeListener::Tick ( )

pure virtual

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

Parameters

time	is the current simulation timestep

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

Tock()

virtual void cyclus::TimeListener::Tock ( )

pure virtual

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

Parameters

time	is the current simulation timestep

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

---

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

• time_listener.h