Packet.h

Go to the documentation of this file.

/*                                              -*- mode:C++ -*-
  Packet.h Basic type for inter-tile communication
  Copyright (C) 2014 The Regents of the University of New Mexico.  All rights reserved.

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
  USA
*/

#ifndef PACKET_H
#define PACKET_H

#include "Dirs.h"
#include "itype.h"

namespace MFM
{

  typedef enum
    {
      PACKET_WRITE = 0,

      PACKET_EVENT_COMPLETE,

      PACKET_EVENT_ACKNOWLEDGE

    }PacketType;

  template <class T>
  class Packet
  {
  private:

    u8 m_type;

    u8 m_toNeighbor;

    u8 m_generation;

    SSPoint m_edgeLoc;

    T m_atom;

  public:

    Packet(PacketType type, u8 generation) :
      m_type(type),
      m_toNeighbor(Dirs::DIR_COUNT), // Init invalid
      m_generation(generation)
    { }

    const char* GetTypeString()
    {
      switch(m_type)
      {
      case PACKET_WRITE: return "Write";
      case PACKET_EVENT_COMPLETE: return "Event Complete";
      case PACKET_EVENT_ACKNOWLEDGE: return "Event Acknowledge";
      }
      return "INVALID";
    }

    PacketType GetType()
    {
      return (PacketType) m_type;
    }

    void SetType(PacketType type)
    {
      m_type = type;
    }

    void SetAtom(const T& atom)
    {
      m_atom = atom;
    }

    void SetReceivingNeighbor(Dir dir)
    {
      m_toNeighbor = dir;
    }

    u32 GetReceivingNeighbor()
    {
      return m_toNeighbor;
    }

    T& GetAtom()
    {
      return m_atom;
    }

    void SetLocation(const SPoint& fromPt)
    {
      m_edgeLoc = SSPoint(fromPt.GetX(), fromPt.GetY());
    }

    const SPoint GetLocation() const
    {
      return SPoint(m_edgeLoc.GetX(), m_edgeLoc.GetY());
    }

    const u8 GetGeneration() const
    {
      return m_generation;
    }

    void SetGeneration(u8 generation)
    {
      m_generation = generation;
    }

    bool IsObsolete(u8 ourGeneration) const
    {
      return ((u8) (m_generation - ourGeneration)) >= U8_MAX / 2;
    }
  };
} /* namespace MFM */

#endif /*PACKET_H*/