/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */

/*

 * Copyright (c) 2008 INESC Porto

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License version 2 as

 * published by the Free Software Foundation;

 *

 * This program 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 General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 *

 * C++ helper functions for use by the python visualizer (for things

 * Python is too slow at).

 *

 * Author: Gustavo Carneiro  <gjc@inescporto.pt>

 */

#ifndef NS3_PYVIZ_H

#define NS3_PYVIZ_H

#include "ns3/nstime.h"

#include "ns3/node.h"

#include "ns3/channel.h"

#include "ns3/packet.h"

#include "ns3/mac48-address.h"

#include <map>

namespace ns3 {

class PyViz

{

public:

  PyViz ();

  ~PyViz ();

  // Run simulation until a given (simulated, absolute) time is reached

  void SimulatorRunUntil (Time time);

  struct TransmissionSample

  {

    Ptr<Node> transmitter;

    Ptr<Node> receiver; // NULL if broadcast

    Ptr<Channel> channel;

    uint32_t bytes;

  };

  typedef std::vector<TransmissionSample> TransmissionSampleList;

  TransmissionSampleList GetTransmissionSamples () const;

private:

  struct TxRecord

  {

    Ptr<Node> srcNode;

  };

  std::map<uint32_t, TxRecord> m_txRecords;

  struct TransmissionSampleKey

  {

    bool operator < (TransmissionSampleKey const &other) const;

    Ptr<Node> transmitter;

    Ptr<Node> receiver; // NULL if broadcast

    Ptr<Channel> channel;

  };

  struct TransmissionSampleValue

  {

    TransmissionSampleValue () : bytes (0) {}

    uint32_t bytes;

  };

  std::map<TransmissionSampleKey, TransmissionSampleValue> m_transmissionSamples;

  void TraceNetDevTx (std::string context, Ptr<const Packet> packet, Mac48Address address);

  void TraceNetDevRx (std::string context, Ptr<const Packet> packet, Mac48Address address);

};

}

#endif /* NS3_PYVIZ_H */