---

SRecEvent Class Reference

#include <SRecEvent.h>

Inherits SEvent.

Inheritance diagram for SRecEvent:

[legend]List of all members.

Public Types
enum	Type {   ILLEGAL, SCHEDEVENT, VISEVENT, EDITEVENT,   PREFEVENT, ALGEVENT }
Public Methods
	SRecEvent (const SEvent &ev, const STaskSystem &ts)
	SRecEvent (const SEvent &ev)
virtual	~SRecEvent ()
virtual void	write (std::ostream &os) const
double	getTimeStamp () const
void	setTimeStamp (double time)
const SEvent &	getEvent () const
virtual Type	getType () const

---

Detailed Description

Event that will be recorded to file by SPlayerLog and played by the player module SPlayer. It stores any kind of SEvent and all necessary information from the tasksystem, that is needed by the player module to let it act exactly like an algorithm. Currently a "time stamp" (the simulation step, where the event was created) is appended.

---

Member Enumeration Documentation

enum SEvent::Type [inherited]

Types of events : ILLEGAL, SCHEDEVENT, VISEVENT, EDITEVENT, PREFEVENT Enumeration values: ILLEGAL  SCHEDEVENT  VISEVENT  EDITEVENT  PREFEVENT  ALGEVENT

---

Constructor & Destructor Documentation

SRecEvent::SRecEvent (  const SEvent &    ev, const STaskSystem &    ts )

Constructor. Currently used by SPlayerLog::update() to record an event. Parameters: ev  event to be enveloped ts  reference to the tasksystem

SRecEvent::SRecEvent (  const SEvent &    ev )

Constructor. Currently used by SPlayer to load and re-play a player-file. Parameters: ev  event to be re-played

SRecEvent::~SRecEvent (    )  [virtual]

---

Member Function Documentation

const SEvent& SRecEvent::getEvent (    )  const [inline]

Get the enveloped event (without additional information) Returns: the original event

double SRecEvent::getTimeStamp (    )  const [inline]

Get the time stamp of an event. This is the time when the event was originally created by the tasksystem. Returns: time stamp

virtual Type SEvent::getType (    )  const [inline, virtual, inherited]

Get the type of an event Returns: type of event Reimplemented in SAlgEvent, SPrefEvent, STSysEditEvent, STSysSchedEvent, and STSysVisEvent.

void SRecEvent::setTimeStamp (  double    time )  [inline]

Set the time stamp of an event. Parameters: time  time stamp

void SRecEvent::write (  std::ostream &    os )  const [virtual]

Write the event and additional information (time stamp) to stream Parameters: os  output stream Reimplemented from SEvent.

---

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

• model/SRecEvent.h
• model/SRecEvent.cpp

---