lte-control-messages.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>
 * Author: Marco Miozzo <marco.miozzo@cttc.es>
 */

#ifndef LTE_CONTROL_MESSAGES_H
#define LTE_CONTROL_MESSAGES_H

#include <ns3/ptr.h>
#include <ns3/simple-ref-count.h>
#include <ns3/ff-mac-common.h>
#include <ns3/lte-rrc-sap.h>
#include <list>

namespace ns3 {

class LteNetDevice;


class LteControlMessage : public SimpleRefCount<LteControlMessage>
{
public:
  enum MessageType
  {
    DL_DCI, UL_DCI, // Downlink/Uplink Data Control Indicator
    DL_CQI, UL_CQI, // Downlink/Uplink Channel Quality Indicator
    BSR, // Buffer Status Report
    DL_HARQ, // UL HARQ feedback
    RACH_PREAMBLE, // Random Access Preamble
    RAR, // Random Access Response
    MIB, // Master Information Block
    SIB1, // System Information Block Type 1
  };

  LteControlMessage (void);
  virtual ~LteControlMessage (void);

  void SetMessageType (MessageType type);
  MessageType GetMessageType (void);

private:
  MessageType m_type;
};


// -----------------------------------------------------------------------

class DlDciLteControlMessage : public LteControlMessage
{
public:
  DlDciLteControlMessage (void);
  virtual ~DlDciLteControlMessage (void);

  void SetDci (DlDciListElement_s dci);

  DlDciListElement_s GetDci (void);

private:
  DlDciListElement_s m_dci;
};


// ---------------------------------------------------------------------------

class UlDciLteControlMessage : public LteControlMessage
{
public:
  UlDciLteControlMessage (void);
  virtual ~UlDciLteControlMessage (void);

  void SetDci (UlDciListElement_s dci);

  UlDciListElement_s GetDci (void);

private:
  UlDciListElement_s m_dci;
};


// ---------------------------------------------------------------------------

class DlCqiLteControlMessage : public LteControlMessage
{
public:
  DlCqiLteControlMessage (void);
  virtual ~DlCqiLteControlMessage (void);

  void SetDlCqi (CqiListElement_s dlcqi);

  CqiListElement_s GetDlCqi (void);

private:
  CqiListElement_s m_dlCqi;
};


// ---------------------------------------------------------------------------

class BsrLteControlMessage : public LteControlMessage
{
public:
  BsrLteControlMessage (void);
  virtual ~BsrLteControlMessage (void);

  void SetBsr (MacCeListElement_s bsr);

  MacCeListElement_s GetBsr (void);

private:
  MacCeListElement_s m_bsr;

};


// ---------------------------------------------------------------------------

class DlHarqFeedbackLteControlMessage : public LteControlMessage
{
public:
  DlHarqFeedbackLteControlMessage (void);
  virtual ~DlHarqFeedbackLteControlMessage (void);

  void SetDlHarqFeedback (DlInfoListElement_s m);

  DlInfoListElement_s GetDlHarqFeedback (void);

private:
  DlInfoListElement_s m_dlInfoListElement;

};


// ---------------------------------------------------------------------------

class RachPreambleLteControlMessage : public LteControlMessage
{
public:
  RachPreambleLteControlMessage (void);
  
  void SetRapId (uint32_t rapid);
  
  uint32_t GetRapId () const;

private:
  uint32_t m_rapId;

};


// ---------------------------------------------------------------------------

class RarLteControlMessage : public LteControlMessage
{
public:
  RarLteControlMessage (void);

  void SetRaRnti (uint16_t raRnti);

  uint16_t GetRaRnti () const;

  struct Rar
  {
    uint8_t rapId;
    BuildRarListElement_s rarPayload;
  };

  void AddRar (Rar rar);

  std::list<Rar>::const_iterator RarListBegin () const;
  
  std::list<Rar>::const_iterator RarListEnd () const;

private:
  std::list<Rar> m_rarList;
  uint16_t m_raRnti;

};


// ---------------------------------------------------------------------------

class MibLteControlMessage : public LteControlMessage
{
public:
  MibLteControlMessage (void);

  void SetMib (LteRrcSap::MasterInformationBlock mib);

  LteRrcSap::MasterInformationBlock GetMib () const;

private:
  LteRrcSap::MasterInformationBlock m_mib;

}; // end of class MibLteControlMessage


// ---------------------------------------------------------------------------

class Sib1LteControlMessage : public LteControlMessage
{
public:
  Sib1LteControlMessage (void);

  void SetSib1 (LteRrcSap::SystemInformationBlockType1 sib1);

  LteRrcSap::SystemInformationBlockType1 GetSib1 () const;

private:
  LteRrcSap::SystemInformationBlockType1 m_sib1;

}; // end of class Sib1LteControlMessage


} // namespace ns3

#endif  // LTE_CONTROL_MESSAGES_H