Message.hh revision 7002:48a19d52d939 
1
2/*
3 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met: redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer;
10 * redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution;
13 * neither the name of the copyright holders nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30/*
31 * $Id$
32 */
33
34#ifndef MESSAGE_H
35#define MESSAGE_H
36
37#include <iostream>
38
39#include "mem/ruby/common/Global.hh"
40#include "mem/gems_common/RefCnt.hh"
41#include "mem/gems_common/RefCountable.hh"
42#include "mem/ruby/eventqueue/RubyEventQueue.hh"
43
44class Message;
45typedef RefCnt<Message> MsgPtr;
46
47class Message : public RefCountable {
48public:
49  // Constructors
50  Message() : RefCountable() { m_time = g_eventQueue_ptr->getTime();  m_LastEnqueueTime = g_eventQueue_ptr->getTime(); m_DelayedCycles = 0;}
51
52  // Destructor
53  virtual ~Message() { }
54
55  // Public Methods
56  virtual Message* clone() const = 0;
57  virtual void destroy() = 0;
58  virtual void print(std::ostream& out) const = 0;
59
60  void setDelayedCycles(const int& cycles) { m_DelayedCycles = cycles; }
61  const int& getDelayedCycles() const {return m_DelayedCycles;}
62  int& getDelayedCycles() {return m_DelayedCycles;}
63  void setLastEnqueueTime(const Time& time) { m_LastEnqueueTime = time; }
64  const Time& getLastEnqueueTime() const {return m_LastEnqueueTime;}
65  Time& getLastEnqueueTime() {return m_LastEnqueueTime;}
66
67  const Time& getTime() const { return m_time; }
68  void setTime(const Time& new_time) { m_time = new_time; }
69private:
70  // Private Methods
71
72  // Data Members (m_ prefix)
73  Time m_time;
74  Time m_LastEnqueueTime; // my last enqueue time
75  int m_DelayedCycles; // my delayed cycles
76
77};
78
79// Output operator declaration
80std::ostream& operator<<(std::ostream& out, const Message& obj);
81
82// ******************* Definitions *******************
83
84// Output operator definition
85extern inline
86std::ostream& operator<<(std::ostream& out, const Message& obj)
87{
88  obj.print(out);
89  out << std::flush;
90  return out;
91}
92
93#endif //MESSAGE_H
94