SimEvent Class Reference

Base class for events that arise in simulation. More...

#include <Simulation/SimEvent.H>

Inherited by SimEventAttentionGateOutput, SimEventAttentionGateStageTwoSegments, SimEventAttentionGuidanceMapOutput, SimEventBreak, SimEventClockTick, SimEventContoursBias, SimEventContoursOutput, SimEventCornersOutput, SimEventEyeTrackerData, SimEventGanglionOutput, SimEventGeons2DOutput, SimEventGeons3DOutput, SimEventGeons3DPrior, SimEventGistOutput, SimEventHandTrackerData, SimEventInputDescription, SimEventInputFrame, SimEventITOutput, SimEventLGNOutput, SimEventLineMatchingOutput, SimEventObjectDescription, SimEventObjectToBias, SimEventRegionsOutput, SimEventRegionsPrior, SimEventRequestFrameNum, SimEventRequestSaveOutput, SimEventRetinaImage, SimEventSaccadeStatus, SimEventSaliencyMapOutput, SimEventSaveOutput, SimEventSceneDescription, SimEventSetVisualTracker, SimEventShapeEstimatorOutput, SimEventShowMemStats, SimEventSMapOutput, SimEventTargetMask, SimEventTargetsHit, SimEventTaskRelevanceMapOutput, SimEventTwoHalfDSketchOutput, SimEventUserInput, SimEventUserWait, SimEventV1Bias, SimEventV1Output, SimEventV2Output, SimEventV4BiasOutput, SimEventV4dOutput, SimEventV4Output, SimEventVisualBufferOutput, SimEventVisualCortexOutput, SimEventVisualTracker, and SimEventWTAwinner.

Collaboration diagram for SimEvent:

[legend]

List of all members.

Public Member Functions
	SimEvent (SimModule *src)
	Constuctor.
virtual	~SimEvent ()
	Destructor.
virtual std::string	toString () const
	Get a description for printing out.
std::string	getDoneList () const
	Get comma-separated list of receivers done with the event.
Friends
class	SimEventQueue

---

Detailed Description

Base class for events that arise in simulation.

Actual events would normally derive from this base. See Simulation/SimEvents.H

Definition at line 48 of file SimEvent.H.

---

Constructor & Destructor Documentation

SimEvent::SimEvent

(

SimModule *

src

)

Constuctor.

Normally a SimModule would pass "this" as src. This is used in SimEventQueue to prune older events that have been pushed by the same SimModule. The event will be visible to anyone through SimEventQueue::check() after it has been posted to the SimEventQueue.

Definition at line 43 of file SimEvent.C.

SimEvent::~SimEvent

(

)

[virtual]

Destructor.

Definition at line 48 of file SimEvent.C.

---

Member Function Documentation

std::string SimEvent::getDoneList

(

)

const

Get comma-separated list of receivers done with the event.

Normally, few people except for SimEventQueue would use this function.

Definition at line 67 of file SimEvent.C.

References ModelComponent::stop().

std::string SimEvent::toString

(

)

const [virtual]

Get a description for printing out.

The base class implementation only returns the demangled name of the class. Overload as necessary in derived classes if you want to also return additional information.

Reimplemented in SimEventInputFrame, SimEventWTAwinner, SimEventTargetsHit, SimEventRetinaImage, SimEventVisualCortexOutput, SimEventSaliencyMapOutput, SimEventGistOutput, SimEventTaskRelevanceMapOutput, SimEventAttentionGuidanceMapOutput, SimEventAttentionGateOutput, SimEventShapeEstimatorOutput, SimEventSaccadeStatus, SimEventTargetMask, SimEventVisualBufferOutput, SimEventBreak, SimEventUserWait, and SimEventClockTick.

Definition at line 52 of file SimEvent.C.

References rutz::demangled_name(), sformat(), and ModelComponent::tagName().

Referenced by SimEventUserWait::toString(), and SimEventBreak::toString().

---

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

• src/Simulation/SimEvent.H
• src/Simulation/SimEvent.C