MsgRetrievingFunction.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
/****************************************************************************/
// Encapsulates an object's method for using it as a message retriever
/****************************************************************************/
#pragma once
#include <config.h>
#include <string>
#include <sstream>
#include <utils/iodevices/OutputDevice.h>
#include "MsgHandler.h"
 
 
// ===========================================================================
// class definitions
// ===========================================================================
template< class T >
class MsgRetrievingFunction : public OutputDevice {
public:
    typedef void(T::* Operation)(const MsgHandler::MsgType, const std::string&);
 
 
    MsgRetrievingFunction(T* object, Operation operation, MsgHandler::MsgType type) :
        myObject(object),
        myOperation(operation),
        myMsgType(type) {}
 
 
    ~MsgRetrievingFunction() {}
 
 
protected:
 
    std::ostream& getOStream() {
        return myMessage;
    }
 
 
    virtual void postWriteHook() {
        (myObject->*myOperation)(myMsgType, myMessage.str());
        myMessage.str("");
    }
 
 
private:
    T* myObject;
 
    Operation myOperation;
 
    MsgHandler::MsgType myMsgType;
 
    std::ostringstream myMessage;
 
};