MSPModel_JuPedSim::Event Class Reference

#include <MSPModel_JuPedSim.h>

Inheritance diagram for MSPModel_JuPedSim::Event:

Collaboration diagram for MSPModel_JuPedSim::Event:

Public Member Functions
	Event (MSPModel_JuPedSim *model)
SUMOTime	execute (SUMOTime currentTime) override
	Executes the command.
virtual SUMOTime	shiftTime (SUMOTime, SUMOTime, SUMOTime)
	Reschedule or deschedule the command when quick-loading state.

Data Fields
int	priority = 0

Private Attributes
MSPModel_JuPedSim *	myModel

Detailed Description

Definition at line 63 of file MSPModel_JuPedSim.h.

Constructor & Destructor Documentation

Event()

MSPModel_JuPedSim::Event::Event ( MSPModel_JuPedSim * model )

inlineexplicit

Definition at line 65 of file MSPModel_JuPedSim.h.

References MSPModel_JuPedSim::MSPModel_JuPedSim(), and myModel.

Member Function Documentation

execute()

SUMOTime MSPModel_JuPedSim::Event::execute ( SUMOTime currentTime )

inlineoverridevirtual

Executes the command.

The implementations should return 0 if the command shall not be repeated, or a value larger than 0 that describe the time after which the command shall be executed again. Values below 0 must not be returned.

Parameters

[in]

currentTime

The current simulation time

Returns

The time after which the command shall be executed again, 0 if this command shall be descheduled.

Exceptions

ProcessError

Derived actions may throw this exception

Implements Command.

Definition at line 67 of file MSPModel_JuPedSim.h.

References myModel.

shiftTime()

virtual SUMOTime Command::shiftTime ( SUMOTime , SUMOTime , SUMOTime  )

inlinevirtualinherited

Reschedule or deschedule the command when quick-loading state.

The implementations should return -1 if the command shall not be re-scheduled, or a value >= 0 that describe the new time at which the command shall be executed again.

Parameters

[in]	currentTime	The current simulation time
[in]	execTime	The time at which the command would have been executed
[in]	newTime	The simulation time at which the simulation is restarted

Returns

The time at which the command shall be executed again

Reimplemented in MSCalibrator::CalibratorCommand, and MSTrafficLightLogic::SwitchCommand.

Definition at line 83 of file Command.h.

Field Documentation

myModel

MSPModel_JuPedSim* MSPModel_JuPedSim::Event::myModel

private

Definition at line 72 of file MSPModel_JuPedSim.h.

Referenced by Event(), and execute().

priority

int Command::priority = 0

inherited

Definition at line 87 of file Command.h.

Referenced by MSTransportableDevice_FCDReplay::MovePedestrians::MovePedestrians(), and MSTrafficLightLogic::SwitchCommand::SwitchCommand().

---

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

• MSPModel_JuPedSim.h