Eclipse SUMO - Simulation of Urban MObility
WrappingCommand.h
Go to the documentation of this file.
1 /****************************************************************************/
2 // Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
3 // Copyright (C) 2001-2024 German Aerospace Center (DLR) and others.
4 // This program and the accompanying materials are made available under the
5 // terms of the Eclipse Public License 2.0 which is available at
6 // https://www.eclipse.org/legal/epl-2.0/
7 // This Source Code may also be made available under the following Secondary
8 // Licenses when the conditions for such availability set forth in the Eclipse
9 // Public License 2.0 are satisfied: GNU General Public License, version 2
10 // or later which is available at
11 // https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
12 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
13 /****************************************************************************/
19 // A wrapper for a Command function
20 /****************************************************************************/
21 #pragma once
22 #include <config.h>
23 #include "Command.h"
24 
25 
26 // ===========================================================================
27 // class definition
28 // ===========================================================================
48 template< class T >
49 class WrappingCommand : public Command {
50 public:
52  typedef SUMOTime(T::* Operation)(SUMOTime);
53 
54 
55 public:
62  WrappingCommand(T* receiver, Operation operation)
63  : myReceiver(receiver), myOperation(operation),
64  myAmDescheduledByParent(false) {}
65 
66 
69 
70 
76  void deschedule() {
78  }
79 
81  bool isDescheduled() {
83  }
84 
85 
88 
98  SUMOTime execute(SUMOTime currentTime) {
99  // do not execute if the command was descheduled
101  return 0;
102  }
103  // execute if stil valid
104  return (myReceiver->*myOperation)(currentTime);
105  }
107 
108 
109 private:
112 
115 
118 
119 
120 };
long long int SUMOTime
Definition: GUI.h:35
Base (microsim) event class.
Definition: Command.h:50
A wrapper for a Command function.
Operation myOperation
The object's operation to perform.
void deschedule()
Marks this Command as being descheduled.
bool myAmDescheduledByParent
Whether this command was descheduled (is invalid) and shall not be executed.
SUMOTime(T::* Operation)(SUMOTime)
Type of the function to execute.
WrappingCommand(T *receiver, Operation operation)
Constructor.
T * myReceiver
The object the action is directed to.
bool isDescheduled()
whether this command has been descheduled
SUMOTime execute(SUMOTime currentTime)
Executes the command.
~WrappingCommand()
Destructor.