ParametrisedWrappingCommand.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2024 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// A wrapper for a Command function with parameter
/****************************************************************************/
 
#pragma once
#include <config.h>
 
#include "Command.h"
 
 
// ===========================================================================
// class definition
// ===========================================================================
template< class T, class S  >
class ParametrisedWrappingCommand : public Command {
public:
 
    typedef SUMOTime(T::* Operation)(SUMOTime, S);
 
public:
 
    ParametrisedWrappingCommand(T* receiver, const S& param, Operation operation)
        : myReceiver(receiver), myParameter(param), myOperation(operation),
          myAmDescheduledByParent(false) {}
 
 
    ~ParametrisedWrappingCommand() {}
 
 
    void deschedule() {
        myAmDescheduledByParent = true;
    }
 
    bool isDescheduled() {
        return myAmDescheduledByParent;
    }
 
 
 
    SUMOTime execute(SUMOTime currentTime) {
        // do not execute if the command was descheduled
        if (myAmDescheduledByParent) {
            return 0;
        }
        // execute if stil valid
        return (myReceiver->*myOperation)(currentTime, myParameter);
    }
 
 
private:
    T* myReceiver;
 
    S myParameter;
 
    Operation myOperation;
 
    bool myAmDescheduledByParent;
 
};