Message.hh revision 6145:15cca6ab723a 
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 "Global.hh"
38#include "RefCnt.hh"
39#include "RefCountable.hh"
40#include "EventQueue.hh"
41
42class Message;
43typedef RefCnt<Message> MsgPtr;
44
45class Message : public RefCountable {
46public:
47  // Constructors
48  Message() : RefCountable() { m_time = g_eventQueue_ptr->getTime();  m_LastEnqueueTime = g_eventQueue_ptr->getTime(); m_DelayedCycles = 0;}
49
50  // Destructor
51  virtual ~Message() { }
52
53  // Public Methods
54  virtual Message* clone() const = 0;
55  virtual void destroy() = 0;
56  virtual void print(ostream& out) const = 0;
57
58  void setDelayedCycles(const int& cycles) { m_DelayedCycles = cycles; }
59  const int& getDelayedCycles() const {return m_DelayedCycles;}
60  int& getDelayedCycles() {return m_DelayedCycles;}
61  void setLastEnqueueTime(const Time& time) { m_LastEnqueueTime = time; }
62  const Time& getLastEnqueueTime() const {return m_LastEnqueueTime;}
63  Time& getLastEnqueueTime() {return m_LastEnqueueTime;}
64
65  const Time& getTime() const { return m_time; }
66  void setTime(const Time& new_time) { m_time = new_time; }
67private:
68  // Private Methods
69
70  // Data Members (m_ prefix)
71  Time m_time;
72  Time m_LastEnqueueTime; // my last enqueue time
73  int m_DelayedCycles; // my delayed cycles
74
75};
76
77// Output operator declaration
78ostream& operator<<(ostream& out, const Message& obj);
79
80// ******************* Definitions *******************
81
82// Output operator definition
83extern inline
84ostream& operator<<(ostream& out, const Message& obj)
85{
86  obj.print(out);
87  out << flush;
88  return out;
89}
90
91#endif //MESSAGE_H
92