/* -*- 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 <list>
namespace ns3 {
class LteNetDevice;
/**
* \ingroup lte
*
* The LteControlMessage provides a basic implementations for
* control messages (such as PDCCH allocation map, CQI feedbacks)
* that are exchanged among eNodeB and UEs.
*/
class LteControlMessage : public SimpleRefCount<LteControlMessage>
{
public:
/**
* The type of the message
*/
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
};
LteControlMessage (void);
virtual ~LteControlMessage (void);
/**
* \brief Set the type of the message
* \param type the type of the message
*/
void SetMessageType (MessageType type);
/**
* \brief Get the type of the message
* \return the type of the message
*/
MessageType GetMessageType (void);
private:
MessageType m_type;
};
} // namespace ns3
#endif /* LTE_CONTROL_MESSAGES_H */
// -----------------------------------------------------------------------
#ifndef DL_DCI_LTE_CONTROL_MESSAGES_H
#define DL_DCI_LTE_CONTROL_MESSAGES_H
#include <ns3/object.h>
#include <ns3/ff-mac-common.h>
namespace ns3 {
/**
* \ingroup lte
* The Downlink Data Control Indicator messages defines the RB allocation for the
* users in the downlink
*/
class DlDciLteControlMessage : public LteControlMessage
{
public:
DlDciLteControlMessage (void);
virtual ~DlDciLteControlMessage (void);
/**
* \brief add a DCI into the message
* \param dci the dci
*/
void SetDci (DlDciListElement_s dci);
/**
* \brief Get dic informations
* \return dci messages
*/
DlDciListElement_s GetDci (void);
private:
DlDciListElement_s m_dci;
};
} // namespace ns3
#endif /* DL_DCI_LTE_CONTROL_MESSAGES_H */
// ---------------------------------------------------------------------------
#ifndef UL_DCI_LTE_CONTROL_MESSAGES_H
#define UL_DCI_LTE_CONTROL_MESSAGES_H
#include <ns3/object.h>
#include <ns3/ff-mac-common.h>
namespace ns3 {
/**
* \ingroup lte
* The Uplink Data Control Indicator messages defines the RB allocation for the
* users in the uplink
*/
class UlDciLteControlMessage : public LteControlMessage
{
public:
UlDciLteControlMessage (void);
virtual ~UlDciLteControlMessage (void);
/**
* \brief add a DCI into the message
* \param dci the dci
*/
void SetDci (UlDciListElement_s dci);
/**
* \brief Get dic informations
* \return dci messages
*/
UlDciListElement_s GetDci (void);
private:
UlDciListElement_s m_dci;
};
} // namespace ns3
#endif /* UL_DCI_LTE_CONTROL_MESSAGES_H */
// ---------------------------------------------------------------------------
#ifndef DLCQI_LTE_CONTROL_MESSAGES_H
#define DLCQI_LTE_CONTROL_MESSAGES_H
#include <ns3/object.h>
#include <ns3/ff-mac-common.h>
namespace ns3 {
class LteNetDevice;
/**
* \ingroup lte
* The downlink CqiLteControlMessage defines an ideal list of
* feedback about the channel quality sent by the UE to the eNodeB.
*/
class DlCqiLteControlMessage : public LteControlMessage
{
public:
DlCqiLteControlMessage (void);
virtual ~DlCqiLteControlMessage (void);
/**
* \brief add a DL-CQI feedback record into the message.
* \param dlcqi the DL cqi feedback
*/
void SetDlCqi (CqiListElement_s dlcqi);
/**
* \brief Get DL cqi informations
* \return dlcqi messages
*/
CqiListElement_s GetDlCqi (void);
private:
CqiListElement_s m_dlCqi;
};
} // namespace ns3
#endif /* DLCQI_LTE_CONTROL_MESSAGES_H */
// ---------------------------------------------------------------------------
#ifndef BSR_LTE_CONTROL_MESSAGES_H
#define BSR_LTE_CONTROL_MESSAGES_H
#include <ns3/object.h>
#include <ns3/ff-mac-common.h>
namespace ns3 {
class LteNetDevice;
/**
* \ingroup lte
* The uplink BsrLteControlMessage defines the specific
* extension of the CE element for reporting the buffer status report
*/
class BsrLteControlMessage : public LteControlMessage
{
public:
BsrLteControlMessage (void);
virtual ~BsrLteControlMessage (void);
/**
* \brief add a BSR feedback record into the message.
* \param bsr the BSR feedback
*/
void SetBsr (MacCeListElement_s ulcqi);
/**
* \brief Get BSR informations
* \return BSR message
*/
MacCeListElement_s GetBsr (void);
private:
MacCeListElement_s m_bsr;
};
} // namespace ns3
#endif /* BSR_LTE_CONTROL_MESSAGES_H */
// ---------------------------------------------------------------------------
#ifndef DL_HARQ_LTE_CONTROL_MESSAGES_H
#define DL_HARQ_LTE_CONTROL_MESSAGES_H
#include <ns3/object.h>
#include <ns3/ff-mac-common.h>
namespace ns3 {
/**
* \ingroup lte
* The downlink DlHarqFeedbackLteControlMessage defines the specific
* messages for transmitting the DL HARQ feedback through PUCCH
*/
class DlHarqFeedbackLteControlMessage : public LteControlMessage
{
public:
DlHarqFeedbackLteControlMessage (void);
virtual ~DlHarqFeedbackLteControlMessage (void);
/**
* \brief add a DL HARQ feedback record into the message.
* \param DlInfoListElement_s the dl HARQ feedback
*/
void SetDlHarqFeedback (DlInfoListElement_s m);
/**
* \brief Get DL HARQ informations
* \return DL HARQ message
*/
DlInfoListElement_s GetDlHarqFeedback (void);
private:
DlInfoListElement_s m_dlInfoListElement;
};
} // namespace ns3
#endif /* DL_HARQ_LTE_CONTROL_MESSAGES_H */
#ifndef RACH_PREAMBLE_LTE_CONTROL_MESSAGES_H
#define RACH_PREAMBLE_LTE_CONTROL_MESSAGES_H
#include <ns3/object.h>
#include <ns3/ff-mac-common.h>
namespace ns3 {
class LteNetDevice;
/**
* \ingroup lte
*
* abstract model for the Random Access Preamble
*/
class RachPreambleLteControlMessage : public LteControlMessage
{
public:
RachPreambleLteControlMessage (void);
/**
* Set the Random Access Preamble Identifier (RAPID), see 3GPP TS 36.321 6.2.2
*
* \param rapid
*/
void SetRapId (uint32_t rapid);
/**
*
* \return the RAPID
*/
uint32_t GetRapId () const;
private:
uint32_t m_rapId;
};
} // namespace ns3
#endif // RACH_PREAMBLE_LTE_CONTROL_MESSAGES_H
#ifndef RAR_LTE_CONTROL_MESSAGES_H
#define RAR_LTE_CONTROL_MESSAGES_H
#include <ns3/object.h>
#include <ns3/ff-mac-common.h>
namespace ns3 {
class LteNetDevice;
/**
* \ingroup lte
*
* abstract model for the MAC Random Access Response message
*/
class RarLteControlMessage : public LteControlMessage
{
public:
RarLteControlMessage (void);
/**
*
* \param raRnti the RA-RNTI, see 3GPP TS 36.321 5.1.4
*/
void SetRaRnti (uint16_t raRnti);
/**
*
* \return the RA-RNTI, see 3GPP TS 36.321 5.1.4
*/
uint16_t GetRaRnti () const;
/**
* a MAC RAR and the corresponding RAPID subheader
*
*/
struct Rar
{
uint8_t rapId;
BuildRarListElement_s rarPayload;
};
/**
* add a RAR to the MAC PDU, see 3GPP TS 36.321 6.2.3
*
* \param rar the rar
*/
void AddRar (Rar rar);
/**
*
* \return a const iterator to the beginning of the RAR list
*/
std::list<Rar>::const_iterator RarListBegin () const;
/**
*
* \return a const iterator to the end of the RAR list
*/
std::list<Rar>::const_iterator RarListEnd () const;
private:
std::list<Rar> m_rarList;
uint16_t m_raRnti;
};
} // namespace ns3
#endif // RAR_LTE_CONTROL_MESSAGES_H
#ifndef MIB_LTE_CONTROL_MESSAGES_H
#define MIB_LTE_CONTROL_MESSAGES_H
#include <ns3/object.h>
#include <ns3/ff-mac-common.h>
#include <ns3/lte-rrc-sap.h>
namespace ns3 {
class LteNetDevice;
/**
* \ingroup lte
*
* abstract model for broadcasting the Master Information Block
*/
class MibLteControlMessage : public LteControlMessage
{
public:
MibLteControlMessage (void);
void SetMib (LteRrcSap::MasterInformationBlock mib);
LteRrcSap::MasterInformationBlock GetMib () const;
private:
LteRrcSap::MasterInformationBlock m_mib;
};
} // namespace ns3
#endif // MIB_LTE_CONTROL_MESSAGES_H