From 4c366ba6491af574eb145a7512bc1879ed15193e Mon Sep 17 00:00:00 2001
From: Josh Pelkey <jpelkey@gatech.edu>
Date: Tue, 30 Mar 2010 12:55:14 -0400
Subject: [PATCH] Add clarifying comments

---
 src/common/packet.cc | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/src/common/packet.cc b/src/common/packet.cc
index 521f69408..340d4b5dd 100644
--- a/src/common/packet.cc
+++ b/src/common/packet.cc
@@ -126,6 +126,12 @@ Packet::Packet ()
   : m_buffer (),
     m_byteTagList (),
     m_packetTagList (),
+    /* The upper 32 bits of the packet id in 
+     * metadata is for the system id. For non-
+     * distributed simulations, this is simply 
+     * zero.  The lower 32 bits are for the 
+     * global UID
+     */
     m_metadata ((uint64_t)Simulator::GetSystemId () << 32 | m_globalUid, 0),
     m_nixVector (0)
 {
@@ -162,6 +168,12 @@ Packet::Packet (uint32_t size)
   : m_buffer (size),
     m_byteTagList (),
     m_packetTagList (),
+    /* The upper 32 bits of the packet id in 
+     * metadata is for the system id. For non-
+     * distributed simulations, this is simply 
+     * zero.  The lower 32 bits are for the 
+     * global UID
+     */
     m_metadata ((uint64_t)Simulator::GetSystemId () << 32 | m_globalUid, size),
     m_nixVector (0)
 {
@@ -182,6 +194,12 @@ Packet::Packet (uint8_t const*buffer, uint32_t size)
   : m_buffer (),
     m_byteTagList (),
     m_packetTagList (),
+    /* The upper 32 bits of the packet id in 
+     * metadata is for the system id. For non-
+     * distributed simulations, this is simply 
+     * zero.  The lower 32 bits are for the 
+     * global UID
+     */
     m_metadata ((uint64_t)Simulator::GetSystemId () << 32 | m_globalUid, size),
     m_nixVector (0)
 {