Eclipse SUMO - Simulation of Urban MObility
MSVehicleControl::DeleteKeptVehicle Class Reference
Inheritance diagram for MSVehicleControl::DeleteKeptVehicle:
[legend]
Collaboration diagram for MSVehicleControl::DeleteKeptVehicle:
[legend]

Public Member Functions

 DeleteKeptVehicle (SUMOVehicle *veh)
 
SUMOTime execute (SUMOTime currentTime)
 Executes the command. More...
 
virtual SUMOTime shiftTime (SUMOTime, SUMOTime, SUMOTime)
 Reschedule or deschedule the command when quick-loading state. More...
 
 ~DeleteKeptVehicle ()
 

Data Fields

int priority = 0
 

Private Member Functions

DeleteKeptVehicleoperator= (const DeleteKeptVehicle &)=delete
 Invalidated assignment operator. More...
 

Private Attributes

SUMOVehiclemyVehicle
 

Detailed Description

Definition at line 643 of file MSVehicleControl.h.

Constructor & Destructor Documentation

◆ DeleteKeptVehicle()

MSVehicleControl::DeleteKeptVehicle::DeleteKeptVehicle ( SUMOVehicle veh)
inline

Definition at line 645 of file MSVehicleControl.h.

◆ ~DeleteKeptVehicle()

MSVehicleControl::DeleteKeptVehicle::~DeleteKeptVehicle ( )
inline

Definition at line 646 of file MSVehicleControl.h.

Member Function Documentation

◆ execute()

SUMOTime MSVehicleControl::DeleteKeptVehicle::execute ( SUMOTime  currentTime)
virtual

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 595 of file MSVehicleControl.cpp.

References MSVehicleControl::deleteVehicle(), MSNet::getInstance(), MSNet::getVehicleControl(), and myVehicle.

◆ operator=()

DeleteKeptVehicle& MSVehicleControl::DeleteKeptVehicle::operator= ( const DeleteKeptVehicle )
privatedelete

Invalidated assignment operator.

◆ 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

◆ myVehicle

SUMOVehicle* MSVehicleControl::DeleteKeptVehicle::myVehicle
private

Definition at line 649 of file MSVehicleControl.h.

Referenced by execute().

◆ priority

int Command::priority = 0
inherited

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