SUMO - Simulation of Urban MObility
|
A wrapper for a Command function. More...
#include <StaticCommand.h>
Public Types | |
typedef SUMOTime(* | Operation )(SUMOTime) |
Type of the function to execute. | |
Public Member Functions | |
void | deschedule () |
Marks this Command as being descheduled. | |
StaticCommand (Operation operation) | |
Constructor. | |
~StaticCommand () | |
Destructor. | |
Derived from Command | |
SUMOTime | execute (SUMOTime currentTime) |
Executes the command. | |
Private Attributes | |
bool | myAmDescheduledByParent |
Whether this command was descheduled (is invalid) and shall not be executed. | |
Operation | myOperation |
The object's operation to perform. |
A wrapper for a Command function.
Definition at line 49 of file StaticCommand.h.
typedef SUMOTime(* StaticCommand< T >::Operation)(SUMOTime) |
Type of the function to execute.
Definition at line 52 of file StaticCommand.h.
StaticCommand< T >::StaticCommand | ( | Operation | operation | ) | [inline] |
Constructor.
[in] | receiver | Pointer to object of type T that will receive a call to one of it's methods. |
[in] | operation | The objects' method that will be called on execute() |
Definition at line 62 of file StaticCommand.h.
StaticCommand< T >::~StaticCommand | ( | ) | [inline] |
Destructor.
Definition at line 67 of file StaticCommand.h.
void StaticCommand< T >::deschedule | ( | ) | [inline] |
Marks this Command as being descheduled.
A simple boolean marker ("myAmDescheduledByParent") is set which prevents this command from being executed.
Definition at line 75 of file StaticCommand.h.
References StaticCommand< T >::myAmDescheduledByParent.
SUMOTime StaticCommand< T >::execute | ( | SUMOTime | currentTime | ) | [inline, virtual] |
Executes the command.
If the command is not descheduled, the stored method of the stored instance is called.
[in] | currentTime | The current simulation time |
ProcessError | Derived actions may throw this exception |
Implements Command.
Definition at line 93 of file StaticCommand.h.
References StaticCommand< T >::myAmDescheduledByParent, and StaticCommand< T >::myOperation.
bool StaticCommand< T >::myAmDescheduledByParent [private] |
Whether this command was descheduled (is invalid) and shall not be executed.
Definition at line 109 of file StaticCommand.h.
Referenced by StaticCommand< T >::deschedule(), and StaticCommand< T >::execute().
Operation StaticCommand< T >::myOperation [private] |
The object's operation to perform.
Definition at line 106 of file StaticCommand.h.
Referenced by StaticCommand< T >::execute().