lte-phy.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2010 TELEMATICS LAB, DEE - Politecnico di Bari
 *
 * 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: Giuseppe Piro  <g.piro@poliba.it>
 *         Marco Miozzo <mmiozzo@cttc.es>
 *         Nicola Baldo <nbaldo@cttc.es>
 */

#ifndef LTE_PHY_H
#define LTE_PHY_H


#include <ns3/spectrum-value.h>
#include <ns3/mobility-model.h>
#include <ns3/packet.h>
#include <ns3/nstime.h>
#include <ns3/spectrum-phy.h>
#include <ns3/spectrum-channel.h>
#include <ns3/spectrum-signal-parameters.h>
#include <ns3/spectrum-interference.h>
#include <ns3/generic-phy.h>
#include <ns3/lte-spectrum-phy.h>

namespace ns3 {

class PacketBurst;
class LteNetDevice;
class LteControlMessage;



class LtePhy : public Object
{

public:
  LtePhy ();

  LtePhy (Ptr<LteSpectrumPhy> dlPhy, Ptr<LteSpectrumPhy> ulPhy);

  virtual ~LtePhy ();

  static TypeId GetTypeId (void);

  void SetDevice (Ptr<LteNetDevice> d);
  Ptr<LteNetDevice> GetDevice () const;

  Ptr<LteSpectrumPhy> GetDownlinkSpectrumPhy ();


  Ptr<LteSpectrumPhy> GetUplinkSpectrumPhy ();

  virtual void DoSendMacPdu (Ptr<Packet> p) = 0;

  void SetDownlinkChannel (Ptr<SpectrumChannel> c);

  void SetUplinkChannel (Ptr<SpectrumChannel> c);


  virtual Ptr<SpectrumValue> CreateTxPowerSpectralDensity () = 0;

  void DoDispose ();

  void SetTti (double tti);
  double GetTti (void) const;

  void DoSetCellId (uint16_t cellId);


  uint8_t GetRbgSize (void) const;
  
  
  uint16_t GetSrsPeriodicity (uint16_t srcCi) const;
  
  uint16_t GetSrsSubframeOffset (uint16_t srcCi) const;


  void SetMacPdu (Ptr<Packet> p);

  Ptr<PacketBurst> GetPacketBurst (void);

  void SetControlMessages (Ptr<LteControlMessage> m);

  std::list<Ptr<LteControlMessage> > GetControlMessages (void);


  virtual void GenerateCtrlCqiReport (const SpectrumValue& sinr) = 0;
  
  virtual void GenerateDataCqiReport (const SpectrumValue& sinr) = 0;

  virtual void ReportInterference (const SpectrumValue& interf) = 0;

  virtual void ReportRsReceivedPower (const SpectrumValue& power) = 0;

  void SetComponentCarrierId (uint8_t index);

  uint8_t GetComponentCarrierId ();

protected:
  Ptr<LteNetDevice> m_netDevice;

  Ptr<LteSpectrumPhy> m_downlinkSpectrumPhy;
  Ptr<LteSpectrumPhy> m_uplinkSpectrumPhy;

  double m_txPower;
  double m_noiseFigure;

  double m_tti;
  uint16_t m_ulBandwidth;
  uint16_t m_dlBandwidth;
  uint8_t m_rbgSize;
  uint32_t m_dlEarfcn;
  uint32_t m_ulEarfcn;

  std::vector< Ptr<PacketBurst> > m_packetBurstQueue;
  std::vector< std::list<Ptr<LteControlMessage> > > m_controlMessagesQueue;
  uint8_t m_macChTtiDelay;

  uint16_t m_cellId;

  uint8_t m_componentCarrierId;

}; // end of `class LtePhy`


}

#endif /* LTE_PHY_H */