GUIEventControl Class Reference

#include <GUIEventControl.h>

Inheritance diagram for GUIEventControl:

---

Detailed Description

Stores time-dependant events and executes them at the proper time (guisim).

Encapsulates MSEventControl-methods using a lock, prohibiting parallel addition / processing of events what may yield in application break due to broken containers.

Definition at line 46 of file GUIEventControl.h.

Public Types
enum	AdaptType { ADAPT_AFTER_EXECUTION = 1, NO_CHANGE = 2 }
	Defines what to do if the insertion time lies before the current simulation time. More...
typedef std::pair< Command *, SUMOTime >	Event
	Combination of an event and the time it shall be executed at.
Public Member Functions
SUMOTime	addEvent (Command *operation, SUMOTime execTimeStep, AdaptType type) throw ()
	Adds an Event.
void	execute (SUMOTime time) throw (ProcessError)
	Executes time-dependant commands.
	GUIEventControl () throw ()
	Default constructor.
bool	isEmpty () throw ()
	Returns whether events are in the que.
void	setCurrentTimeStep (SUMOTime time)
	Set the current Time.
	~GUIEventControl () throw ()
	Destructor.
Private Member Functions
	GUIEventControl (const GUIEventControl &)
	invalid copy constructor.
GUIEventControl &	operator= (const GUIEventControl &)
	invalid assignment operator.
Private Attributes
MFXMutex	myLock
	The lock used to prohibit parallel addition and processing of events.

---

Member Typedef Documentation

typedef std::pair< Command*, SUMOTime > MSEventControl::Event [inherited]

Combination of an event and the time it shall be executed at.

Definition at line 56 of file MSEventControl.h.

---

Member Enumeration Documentation

enum MSEventControl::AdaptType [inherited]

Defines what to do if the insertion time lies before the current simulation time.

Enumerator:

ADAPT_AFTER_EXECUTION	Patch the time in a way that it is at least as high as the simulation begin time.
NO_CHANGE	Do nothing.

Definition at line 63 of file MSEventControl.h.

                   {
        ADAPT_AFTER_EXECUTION = 1,
        NO_CHANGE = 2
    };

---

Constructor & Destructor Documentation

GUIEventControl::GUIEventControl

(

)

throw ()

Default constructor.

Definition at line 44 of file GUIEventControl.cpp.

{}

GUIEventControl::~GUIEventControl

(

)

throw ()

Destructor.

Definition at line 47 of file GUIEventControl.cpp.

                                          {
}

GUIEventControl::GUIEventControl

(

const GUIEventControl &

)

[private]

invalid copy constructor.

---

Member Function Documentation

SUMOTime GUIEventControl::addEvent	(	Command *	operation,
		SUMOTime	execTimeStep,
		AdaptType	type
	)			throw () [virtual]

Adds an Event.

Locks itself before calling MSEventControl::addEvent. Unlock itself after the call.

Parameters:

[in]	operation	The event to add
[in]	execTimeStep	The time the event shall be executed at
[in]	type	The adaptation type

See also:

MSEventControl::addEvent

Reimplemented from MSEventControl.

Definition at line 52 of file GUIEventControl.cpp.

References MSEventControl::addEvent(), MFXMutex::lock(), myLock, and MFXMutex::unlock().

                                                  {
    myLock.lock();
    SUMOTime ret = MSEventControl::addEvent(operation, execTimeStep, type);
    myLock.unlock();
    return ret;
}

void GUIEventControl::execute

(

SUMOTime

time

)

throw (ProcessError) [virtual]

Executes time-dependant commands.

Locks itself before calling MSEventControl::execute. Unlock itself after the call.

Parameters:

[in]

time

The current simulation time

Exceptions:

ProcessError

From an executed Command

See also:

MSEventControl::execute

Reimplemented from MSEventControl.

Definition at line 63 of file GUIEventControl.cpp.

References MSEventControl::execute(), MFXMutex::lock(), myLock, and MFXMutex::unlock().

                                                              {
    myLock.lock();
    try {
        MSEventControl::execute(execTime);
    } catch (ProcessError &) {
        myLock.unlock();
        throw;
    }
    myLock.unlock();
}

bool MSEventControl::isEmpty

(

)

throw () [inherited]

Returns whether events are in the que.

Returns:

whether events are in the que

Definition at line 114 of file MSEventControl.cpp.

References MSEventControl::myEvents.

Referenced by MSNet::simulationState().

                                {
    return myEvents.empty();
}

GUIEventControl& GUIEventControl::operator=

(

const GUIEventControl &

)

[private]

invalid assignment operator.

void MSEventControl::setCurrentTimeStep

(

SUMOTime

time

)

[inherited]

Set the current Time.

This method is only for Unit Testing. Set the current TimeStep used in addEvent. Normally the time is set automatically from an instance of MSNet.

Definition at line 119 of file MSEventControl.cpp.

References MSEventControl::currentTimeStep.

Referenced by TEST().

                                                {
    currentTimeStep = time;
}

---

Field Documentation

MFXMutex GUIEventControl::myLock [private]

The lock used to prohibit parallel addition and processing of events.

Definition at line 84 of file GUIEventControl.h.

Referenced by addEvent(), and execute().

---

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

• GUIEventControl.h
• GUIEventControl.cpp