uan-phy.h

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2009 University of Washington
 *
 * 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
 *
 * Author: Leonard Tracy <lentracy@gmail.com>
 *         Andrea Sacco <andrea.sacco85@gmail.com>
 */


#ifndef UAN_PHY_H
#define UAN_PHY_H

#include "ns3/object.h"
#include "ns3/uan-mac.h"
#include "ns3/uan-tx-mode.h"
#include "ns3/uan-prop-model.h"
#include "ns3/uan-transducer.h"
#include "ns3/device-energy-model.h"

namespace ns3 {


class UanPhyCalcSinr : public Object
{

public:
  static TypeId GetTypeId (void);

  virtual double CalcSinrDb (Ptr<Packet> pkt,
                             Time arrTime,
                             double rxPowerDb,
                             double ambNoiseDb,
                             UanTxMode mode,
                             UanPdp pdp,
                             const UanTransducer::ArrivalList &arrivalList
                             ) const = 0;
  virtual void Clear (void);

  virtual void DoDispose (void);

  inline double DbToKp (double db) const
  {
    return std::pow (10, db / 10.0);
  }
  inline double KpToDb (double kp) const
  {
    return 10 * std::log10 (kp);
  }
};

class UanPhyPer : public Object
{
public:
  static TypeId GetTypeId (void);

  virtual double CalcPer (Ptr<Packet> pkt, double sinrDb, UanTxMode mode) = 0;
  virtual void Clear (void);

  virtual void DoDispose (void);
};


class UanPhyListener
{
public:
  virtual ~UanPhyListener ()
  {
  }
  virtual void NotifyRxStart (void) = 0;
  virtual void NotifyRxEndOk (void) = 0;
  virtual void NotifyRxEndError (void) = 0;
  virtual void NotifyCcaStart (void) = 0;
  virtual void NotifyCcaEnd (void) = 0;
  virtual void NotifyTxStart (Time duration) = 0;
};

class UanPhy : public Object
{
public:
  static TypeId GetTypeId (void);

  enum State
  {
    IDLE, CCABUSY, RX, TX, SLEEP
  };

  typedef Callback<void, Ptr<Packet>, double, UanTxMode> RxOkCallback;

  typedef Callback<void, Ptr<Packet>, double > RxErrCallback;

  virtual void SetEnergyModelCallback (DeviceEnergyModel::ChangeStateCallback callback) = 0;
  virtual void EnergyDepletionHandler (void) = 0;
  virtual void SendPacket (Ptr<Packet> pkt, uint32_t modeNum) = 0;

  virtual void RegisterListener (UanPhyListener *listener) = 0;

  virtual void StartRxPacket (Ptr<Packet> pkt, double rxPowerDb, UanTxMode txMode, UanPdp pdp) = 0;

  virtual void SetReceiveOkCallback (RxOkCallback cb) = 0;

  virtual void SetReceiveErrorCallback (RxErrCallback cb) = 0;

  virtual void SetRxGainDb (double gain) = 0;

  virtual void SetTxPowerDb (double txpwr) = 0;

  virtual void SetRxThresholdDb (double thresh) = 0;

  virtual void SetCcaThresholdDb (double thresh) = 0;

  virtual double GetRxGainDb (void) = 0;

  virtual double GetTxPowerDb (void) = 0;

  virtual double GetRxThresholdDb (void) = 0;

  virtual double GetCcaThresholdDb (void) = 0;
  virtual bool IsStateSleep (void) = 0;
  virtual bool IsStateIdle (void) = 0;
  virtual bool IsStateBusy (void) = 0;
  virtual bool IsStateRx (void) = 0;
  virtual bool IsStateTx (void) = 0;
  virtual bool IsStateCcaBusy (void) = 0;

  virtual Ptr<UanChannel> GetChannel (void) const = 0;

  virtual Ptr<UanNetDevice> GetDevice (void) = 0;

  virtual void SetChannel (Ptr<UanChannel> channel) = 0;

  virtual void SetDevice (Ptr<UanNetDevice> device) = 0;

  virtual void SetMac (Ptr<UanMac> mac) = 0;

  virtual void NotifyTransStartTx (Ptr<Packet> packet, double txPowerDb, UanTxMode txMode) = 0;

  virtual void NotifyIntChange (void) = 0;

  virtual void SetTransducer (Ptr<UanTransducer> trans) = 0;

  virtual Ptr<UanTransducer> GetTransducer (void) = 0;

  virtual uint32_t GetNModes (void) = 0;

  virtual UanTxMode GetMode (uint32_t n) = 0;

  virtual Ptr<Packet> GetPacketRx (void) const = 0;

  virtual void Clear (void) = 0;

  virtual void SetSleepMode (bool sleep) = 0;


  void NotifyTxBegin (Ptr<const Packet> packet);

  void NotifyTxEnd (Ptr<const Packet> packet);

  void NotifyTxDrop (Ptr<const Packet> packet);

  void NotifyRxBegin (Ptr<const Packet> packet);

  void NotifyRxEnd (Ptr<const Packet> packet);

  void NotifyRxDrop (Ptr<const Packet> packet);

  virtual int64_t AssignStreams (int64_t stream) = 0;

private:
  TracedCallback<Ptr<const Packet> > m_phyTxBeginTrace;

  TracedCallback<Ptr<const Packet> > m_phyTxEndTrace;

  TracedCallback<Ptr<const Packet> > m_phyTxDropTrace;

  TracedCallback<Ptr<const Packet> > m_phyRxBeginTrace;

  TracedCallback<Ptr<const Packet> > m_phyRxEndTrace;

  TracedCallback<Ptr<const Packet> > m_phyRxDropTrace;
};

}

#endif /* UAN_PHY_H */