WrappingCommand.h

Go to the documentation of this file.

/****************************************************************************/
// A wrapper for a Command function
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.sourceforge.net/
// Copyright 2001-2010 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This program is free software; you can redistribute it and/or modify
//   it under the terms of the GNU General Public License as published by
//   the Free Software Foundation; either version 2 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#ifndef WrappingCommand_h
#define WrappingCommand_h


// ===========================================================================
// included modules
// ===========================================================================
#ifdef _MSC_VER
#include <windows_config.h>
#else
#include <config.h>
#endif

#include "Command.h"


// ===========================================================================
// class definition
// ===========================================================================
template< class T  >
class WrappingCommand : public Command {
public:
    typedef SUMOTime(T::* Operation)(SUMOTime);


public:
    WrappingCommand(T* receiver, Operation operation) throw()
            : myReceiver(receiver), myOperation(operation),
            myAmDescheduledByParent(false) {}


    ~WrappingCommand() throw() {}


    void deschedule() {
        myAmDescheduledByParent = true;
    }




    SUMOTime execute(SUMOTime currentTime) throw(ProcessError) {
        // do not execute if the command was descheduled
        if (myAmDescheduledByParent) {
            return 0;
        }
        // execute if stil valid
        return (myReceiver->*myOperation)(currentTime);
    }


private:
    T* myReceiver;

    Operation myOperation;

    bool myAmDescheduledByParent;


};


#endif

/****************************************************************************/