SUMO - Simulation of Urban MObility
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MsgRetrievingFunction.h
Go to the documentation of this file.
1 /****************************************************************************/
8 // Encapsulates an object's method for using it as a message retriever
9 /****************************************************************************/
10 // SUMO, Simulation of Urban MObility; see http://sumo-sim.org/
11 // Copyright (C) 2001-2013 DLR (http://www.dlr.de/) and contributors
12 /****************************************************************************/
13 //
14 // This file is part of SUMO.
15 // SUMO is free software: you can redistribute it and/or modify
16 // it under the terms of the GNU General Public License as published by
17 // the Free Software Foundation, either version 3 of the License, or
18 // (at your option) any later version.
19 //
20 /****************************************************************************/
21 #ifndef MsgRetrievingFunction_h
22 #define MsgRetrievingFunction_h
23 
24 
25 // ===========================================================================
26 // included modules
27 // ===========================================================================
28 #ifdef _MSC_VER
29 #include <windows_config.h>
30 #else
31 #include <config.h>
32 #endif
33 
34 #include <string>
35 #include <sstream>
37 #include "MsgHandler.h"
38 
39 
40 // ===========================================================================
41 // class definitions
42 // ===========================================================================
49 template< class T >
51 public:
53  typedef void(T::* Operation)(const MsgHandler::MsgType, const std::string&);
54 
55 
61  MsgRetrievingFunction(T* object, Operation operation, MsgHandler::MsgType type) :
62  myObject(object),
63  myOperation(operation),
64  myMsgType(type) {}
65 
66 
69 
70 
71 protected:
74 
83  std::ostream& getOStream() {
84  return myMessage;
85  }
86 
87 
90  virtual void postWriteHook() {
92  myMessage.str("");
93  }
95 
96 
97 private:
100 
103 
106 
108  std::ostringstream myMessage;
109 
110 };
111 
112 
113 #endif
114 
115 /****************************************************************************/
116 
std::ostream & getOStream()
Returns the associated ostream.
virtual void postWriteHook()
Sends the data which was written to the string stream via the retrieving function.
MsgRetrievingFunction(T *object, Operation operation, MsgHandler::MsgType type)
Constructor.
MsgHandler::MsgType myMsgType
The type of message to retrieve.
Encapsulates an object&#39;s method for using it as a message retriever.
~MsgRetrievingFunction()
Destructor.
void(T::* Operation)(const MsgHandler::MsgType, const std::string &)
Type of the function to execute.
Static storage of an output device and its base (abstract) implementation.
Definition: OutputDevice.h:70
std::ostringstream myMessage
message buffer
Operation myOperation
The object&#39;s operation to perform.
T * myObject
The object the action is directed to.