src/SimulationObject.h

   1 #ifndef SIM_SIMULATIONOBJECT_H
   2 #define SIM_SIMULATIONOBJECT_H
   3
   4 #include "SimulationClock.h"
   5
   6 namespace sim {
   7
   8         /**
   9          * @author Tom Haber
  10          * @date Apr 27, 2008
  11          * @brief An object in the simulation
  12          *
  13          * Represents a member of the simulation, this can be
  14          * either a peripheral or an AVR chip. It contains a
  15          * stepping function and can negotiate with the clock
  16          * for a specific timing.
  17          */
  18         class SimulationObject {
  19                 public:
  20                         SimulationObject(SimulationClock & clock) : clock(clock) {}
  21                         virtual ~SimulationObject() {};
  22
  23                 public:
  24                         /**
  25                          * Perform a single simulation step.
  26                          */
  27                         virtual void step() = 0;
  28
  29                 protected:
  30                         SimulationClock & clock;
  31         };
  32
  33 }
  34
  35 #endif /*SIM_SIMULATIONOBJECT_H*/