Message.hh revision 6145
16145Snate@binkert.org
26145Snate@binkert.org/*
36145Snate@binkert.org * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
46145Snate@binkert.org * All rights reserved.
56145Snate@binkert.org *
66145Snate@binkert.org * Redistribution and use in source and binary forms, with or without
76145Snate@binkert.org * modification, are permitted provided that the following conditions are
86145Snate@binkert.org * met: redistributions of source code must retain the above copyright
96145Snate@binkert.org * notice, this list of conditions and the following disclaimer;
106145Snate@binkert.org * redistributions in binary form must reproduce the above copyright
116145Snate@binkert.org * notice, this list of conditions and the following disclaimer in the
126145Snate@binkert.org * documentation and/or other materials provided with the distribution;
136145Snate@binkert.org * neither the name of the copyright holders nor the names of its
146145Snate@binkert.org * contributors may be used to endorse or promote products derived from
156145Snate@binkert.org * this software without specific prior written permission.
166145Snate@binkert.org *
176145Snate@binkert.org * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
186145Snate@binkert.org * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
196145Snate@binkert.org * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
206145Snate@binkert.org * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
216145Snate@binkert.org * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
226145Snate@binkert.org * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
236145Snate@binkert.org * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
246145Snate@binkert.org * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
256145Snate@binkert.org * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
266145Snate@binkert.org * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
276145Snate@binkert.org * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
286145Snate@binkert.org */
296145Snate@binkert.org
306145Snate@binkert.org/*
316145Snate@binkert.org * $Id$
326145Snate@binkert.org */
336145Snate@binkert.org
346145Snate@binkert.org#ifndef MESSAGE_H
356145Snate@binkert.org#define MESSAGE_H
366145Snate@binkert.org
376145Snate@binkert.org#include "Global.hh"
386145Snate@binkert.org#include "RefCnt.hh"
396145Snate@binkert.org#include "RefCountable.hh"
406145Snate@binkert.org#include "EventQueue.hh"
416145Snate@binkert.org
426145Snate@binkert.orgclass Message;
436145Snate@binkert.orgtypedef RefCnt<Message> MsgPtr;
446145Snate@binkert.org
456145Snate@binkert.orgclass Message : public RefCountable {
466145Snate@binkert.orgpublic:
476145Snate@binkert.org  // Constructors
486145Snate@binkert.org  Message() : RefCountable() { m_time = g_eventQueue_ptr->getTime();  m_LastEnqueueTime = g_eventQueue_ptr->getTime(); m_DelayedCycles = 0;}
496145Snate@binkert.org
506145Snate@binkert.org  // Destructor
516145Snate@binkert.org  virtual ~Message() { }
526145Snate@binkert.org
536145Snate@binkert.org  // Public Methods
546145Snate@binkert.org  virtual Message* clone() const = 0;
556145Snate@binkert.org  virtual void destroy() = 0;
566145Snate@binkert.org  virtual void print(ostream& out) const = 0;
576145Snate@binkert.org
586145Snate@binkert.org  void setDelayedCycles(const int& cycles) { m_DelayedCycles = cycles; }
596145Snate@binkert.org  const int& getDelayedCycles() const {return m_DelayedCycles;}
606145Snate@binkert.org  int& getDelayedCycles() {return m_DelayedCycles;}
616145Snate@binkert.org  void setLastEnqueueTime(const Time& time) { m_LastEnqueueTime = time; }
626145Snate@binkert.org  const Time& getLastEnqueueTime() const {return m_LastEnqueueTime;}
636145Snate@binkert.org  Time& getLastEnqueueTime() {return m_LastEnqueueTime;}
646145Snate@binkert.org
656145Snate@binkert.org  const Time& getTime() const { return m_time; }
666145Snate@binkert.org  void setTime(const Time& new_time) { m_time = new_time; }
676145Snate@binkert.orgprivate:
686145Snate@binkert.org  // Private Methods
696145Snate@binkert.org
706145Snate@binkert.org  // Data Members (m_ prefix)
716145Snate@binkert.org  Time m_time;
726145Snate@binkert.org  Time m_LastEnqueueTime; // my last enqueue time
736145Snate@binkert.org  int m_DelayedCycles; // my delayed cycles
746145Snate@binkert.org
756145Snate@binkert.org};
766145Snate@binkert.org
776145Snate@binkert.org// Output operator declaration
786145Snate@binkert.orgostream& operator<<(ostream& out, const Message& obj);
796145Snate@binkert.org
806145Snate@binkert.org// ******************* Definitions *******************
816145Snate@binkert.org
826145Snate@binkert.org// Output operator definition
836145Snate@binkert.orgextern inline
846145Snate@binkert.orgostream& operator<<(ostream& out, const Message& obj)
856145Snate@binkert.org{
866145Snate@binkert.org  obj.print(out);
876145Snate@binkert.org  out << flush;
886145Snate@binkert.org  return out;
896145Snate@binkert.org}
906145Snate@binkert.org
916145Snate@binkert.org#endif //MESSAGE_H
92