uan-transducer.h

Go to the documentation of this file.

/* -*- 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>
 */

#ifndef UAN_TRANSDUCER_H
#define UAN_TRANSDUCER_H

#include "ns3/object.h"
#include "ns3/packet.h"
#include "uan-tx-mode.h"
#include "ns3/uan-prop-model.h"

#include <list>

namespace ns3 {

class UanPhy;
class UanChannel;


class UanPacketArrival
{
public:

  UanPacketArrival () 
  {
  }

  UanPacketArrival (Ptr<Packet> packet, double rxPowerDb, UanTxMode txMode, UanPdp pdp, Time arrTime)
    : m_packet (packet),
      m_rxPowerDb (rxPowerDb),
      m_txMode (txMode),
      m_pdp (pdp),
      m_arrTime (arrTime)
  {
  }

  ~UanPacketArrival()
  {
    m_packet = 0;
  }

  inline Ptr<Packet> GetPacket (void) const
  {
    return m_packet;
  }
  inline double GetRxPowerDb (void) const
  {
    return m_rxPowerDb;
  }
  inline const UanTxMode &GetTxMode (void) const
  {
    return m_txMode;
  }
  inline Time GetArrivalTime (void) const
  {
    return m_arrTime;
  }
  inline UanPdp GetPdp (void) const
  {
    return m_pdp;
  }
private:
  Ptr<Packet> m_packet;  
  double m_rxPowerDb;    
  UanTxMode m_txMode;    
  UanPdp m_pdp;          
  Time m_arrTime;        

};  // class UanPacketArrival

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

  enum State {
    TX,  
    RX   
  };

  typedef std::list<UanPacketArrival> ArrivalList;
  typedef std::list<Ptr<UanPhy> > UanPhyList;

  virtual State GetState (void) const = 0;

  virtual bool IsRx (void) const = 0;
  virtual bool IsTx (void) const = 0;
  virtual const ArrivalList &GetArrivalList (void) const = 0;
  virtual void SetRxGainDb (double gainDb) = 0;  
  virtual double GetRxGainDb (void) = 0;
  virtual double ApplyRxGainDb (double rxPowerDb, UanTxMode mode) = 0;
  virtual void Receive (Ptr<Packet> packet, double rxPowerDb, UanTxMode txMode, UanPdp pdp) = 0;
  virtual void Transmit (Ptr<UanPhy> src, Ptr<Packet> packet, double txPowerDb, UanTxMode txMode) = 0;
  virtual void SetChannel (Ptr<UanChannel> chan) = 0;
  virtual Ptr<UanChannel> GetChannel (void) const = 0;
  virtual void AddPhy (Ptr<UanPhy> phy) = 0;
  virtual const UanPhyList &GetPhyList (void) const = 0;
  virtual void Clear (void) = 0;

};  // class UanTransducer

} // namespace ns3

#endif /* UAN_TRANSDUCER_H */