uan-phy-dual.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_DUAL_H
#define UAN_PHY_DUAL_H

#include "ns3/uan-phy.h"



namespace ns3 {

class UanTxMode;
class UanModesList;


class UanPhyCalcSinrDual : public UanPhyCalcSinr
{
public:
  UanPhyCalcSinrDual ();
  virtual ~UanPhyCalcSinrDual ();
  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;
};

class UanPhyDual : public UanPhy
{
public:
  UanPhyDual ();
  virtual ~UanPhyDual ();

  static TypeId GetTypeId ();

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

  virtual void RegisterListener (UanPhyListener *listener);
  virtual void StartRxPacket (Ptr<Packet> pkt, double rxPowerDb, UanTxMode txMode, UanPdp pdp);
  virtual void SetReceiveOkCallback (RxOkCallback cb);
  virtual void SetReceiveErrorCallback (RxErrCallback cb);
  virtual void SetRxGainDb (double gain);
  virtual void SetTxPowerDb (double txpwr);
  virtual void SetRxThresholdDb (double thresh);
  virtual void SetCcaThresholdDb (double thresh);
  virtual double GetRxGainDb (void);
  virtual double GetTxPowerDb (void);
  virtual double GetRxThresholdDb (void);
  virtual double GetCcaThresholdDb (void);
  virtual bool IsStateSleep (void);
  virtual bool IsStateIdle (void);
  virtual bool IsStateBusy (void);
  virtual bool IsStateRx (void);
  virtual bool IsStateTx (void);
  virtual bool IsStateCcaBusy (void);
  virtual Ptr<UanChannel> GetChannel (void) const;
  virtual Ptr<UanNetDevice> GetDevice (void);
  virtual void SetChannel (Ptr<UanChannel> channel);
  virtual void SetDevice (Ptr<UanNetDevice> device);
  virtual void SetMac (Ptr<UanMac> mac);
  virtual void NotifyTransStartTx (Ptr<Packet> packet, double txPowerDb, UanTxMode txMode);
  virtual void NotifyIntChange (void);
  virtual void SetTransducer (Ptr<UanTransducer> trans);
  virtual Ptr<UanTransducer> GetTransducer (void);
  virtual uint32_t GetNModes (void);
  virtual UanTxMode GetMode (uint32_t n);
  virtual void Clear (void);

  bool IsPhy1Idle (void);
  bool IsPhy2Idle (void);
  bool IsPhy1Rx (void);
  bool IsPhy2Rx (void);
  bool IsPhy1Tx (void);
  bool IsPhy2Tx (void);

  // Attribute getters and setters
  double GetCcaThresholdPhy1 (void) const;
  double GetCcaThresholdPhy2 (void) const;
  void SetCcaThresholdPhy1 (double thresh);
  void SetCcaThresholdPhy2 (double thresh);

  double GetTxPowerDbPhy1 (void) const;
  double GetTxPowerDbPhy2 (void) const;
  void SetTxPowerDbPhy1 (double);
  void SetTxPowerDbPhy2 (double);

  double GetRxGainDbPhy1 (void) const;
  double GetRxGainDbPhy2 (void) const;
  void SetRxGainDbPhy1 (double gain);
  void SetRxGainDbPhy2 (double gain);

  UanModesList GetModesPhy1 (void) const;
  UanModesList GetModesPhy2 (void) const;
  void SetModesPhy1 (UanModesList modes);
  void SetModesPhy2 (UanModesList modes);

  Ptr<UanPhyPer> GetPerModelPhy1 (void) const;
  Ptr<UanPhyPer> GetPerModelPhy2 (void) const;
  void SetPerModelPhy1 (Ptr<UanPhyPer> per);
  void SetPerModelPhy2 (Ptr<UanPhyPer> per);

  Ptr<UanPhyCalcSinr> GetSinrModelPhy1 (void) const;
  Ptr<UanPhyCalcSinr> GetSinrModelPhy2 (void) const;
  void SetSinrModelPhy1 (Ptr<UanPhyCalcSinr> calcSinr);
  void SetSinrModelPhy2 (Ptr<UanPhyCalcSinr> calcSinr);

  virtual void SetSleepMode (bool sleep)
  {
    //TODO This method has to be implemented
  }

  Ptr<Packet> GetPhy1PacketRx (void) const;
  Ptr<Packet> GetPhy2PacketRx (void) const;
  Ptr<Packet> GetPacketRx (void) const;

  int64_t AssignStreams (int64_t stream);

private:
  Ptr<UanPhy> m_phy1;
  Ptr<UanPhy> m_phy2;
  TracedCallback<Ptr<const Packet>, double, UanTxMode > m_rxOkLogger;
  TracedCallback<Ptr<const Packet>, double, UanTxMode > m_rxErrLogger;
  TracedCallback<Ptr<const Packet>, double, UanTxMode > m_txLogger;
  RxOkCallback m_recOkCb;
  RxErrCallback m_recErrCb;


  void RxOkFromSubPhy (Ptr<Packet> pkt, double sinr, UanTxMode mode);
  void RxErrFromSubPhy (Ptr<Packet> pkt, double sinr);
protected:
  virtual void DoDispose ();
};

}

#endif /* UAN_PHY_DUAL_H */