Eclipse SUMO - Simulation of Urban MObility
MSPModel_JuPedSim::Event Class Reference

#include <MSPModel_JuPedSim.h>

Inheritance diagram for MSPModel_JuPedSim::Event:
[legend]
Collaboration diagram for MSPModel_JuPedSim::Event:
[legend]

Public Member Functions

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

Data Fields

int priority = 0
 

Private Attributes

MSPModel_JuPedSimmyJPSModel
 

Detailed Description

Definition at line 65 of file MSPModel_JuPedSim.h.

Constructor & Destructor Documentation

◆ Event()

MSPModel_JuPedSim::Event::Event ( MSPModel_JuPedSim model)
inlineexplicit

Definition at line 67 of file MSPModel_JuPedSim.h.

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]currentTimeThe current simulation time
Returns
The time after which the command shall be executed again, 0 if this command shall be descheduled.
Exceptions
ProcessErrorDerived actions may throw this exception

Implements Command.

Definition at line 69 of file MSPModel_JuPedSim.h.

References MSPModel_JuPedSim::execute(), and myJPSModel.

◆ 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]currentTimeThe current simulation time
[in]execTimeThe time at which the command would have been executed
[in]newTimeThe 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

◆ myJPSModel

MSPModel_JuPedSim* MSPModel_JuPedSim::Event::myJPSModel
private

Definition at line 74 of file MSPModel_JuPedSim.h.

Referenced by execute().

◆ priority

int Command::priority = 0
inherited

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