nr-epc-x2-header.h

// Copyright (c) 2012 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
//
// SPDX-License-Identifier: GPL-2.0-only
//
// Author: Manuel Requena <manuel.requena@cttc.es>
 
#ifndef NR_EPC_X2_HEADER_H
#define NR_EPC_X2_HEADER_H
 
#include "nr-epc-x2-sap.h"
 
#include "ns3/header.h"
 
#include <vector>
 
namespace ns3
{
class NrEpcX2Header : public Header
{
  public:
    NrEpcX2Header();
    ~NrEpcX2Header() override;
 
    static TypeId GetTypeId();
    TypeId GetInstanceTypeId() const override;
    uint32_t GetSerializedSize() const override;
    void Serialize(Buffer::Iterator start) const override;
    uint32_t Deserialize(Buffer::Iterator start) override;
    void Print(std::ostream& os) const override;
 
    uint8_t GetMessageType() const;
    void SetMessageType(uint8_t messageType);
 
    uint8_t GetProcedureCode() const;
    void SetProcedureCode(uint8_t procedureCode);
 
    void SetLengthOfIes(uint32_t lengthOfIes);
    void SetNumberOfIes(uint32_t numberOfIes);
 
    enum ProcedureCode_t
    {
        HandoverPreparation = 0,
        HandoverCancel = 1,
        LoadIndication = 2,
        SnStatusTransfer = 4,
        UeContextRelease = 5,
        ResourceStatusReporting = 10
    };
 
    enum TypeOfMessage_t
    {
        InitiatingMessage = 0,
        SuccessfulOutcome = 1,
        UnsuccessfulOutcome = 2
    };
 
  private:
    uint8_t m_messageType;   
    uint8_t m_procedureCode; 
 
    uint32_t m_lengthOfIes; 
    uint32_t m_numberOfIes; 
};
 
class NrEpcX2HandoverRequestHeader : public Header
{
  public:
    NrEpcX2HandoverRequestHeader();
    ~NrEpcX2HandoverRequestHeader() override;
 
    static TypeId GetTypeId();
    TypeId GetInstanceTypeId() const override;
    uint32_t GetSerializedSize() const override;
    void Serialize(Buffer::Iterator start) const override;
    uint32_t Deserialize(Buffer::Iterator start) override;
    void Print(std::ostream& os) const override;
 
    uint16_t GetOldGnbUeX2apId() const;
    void SetOldGnbUeX2apId(uint16_t x2apId);
 
    uint16_t GetCause() const;
    void SetCause(uint16_t cause);
 
    uint16_t GetTargetCellId() const;
    void SetTargetCellId(uint16_t targetCellId);
 
    uint32_t GetMmeUeS1apId() const;
    void SetMmeUeS1apId(uint32_t mmeUeS1apId);
 
    std::vector<NrEpcX2Sap::ErabToBeSetupItem> GetBearers() const;
    void SetBearers(std::vector<NrEpcX2Sap::ErabToBeSetupItem> bearers);
 
    uint64_t GetUeAggregateMaxBitRateDownlink() const;
    void SetUeAggregateMaxBitRateDownlink(uint64_t bitRate);
 
    uint64_t GetUeAggregateMaxBitRateUplink() const;
    void SetUeAggregateMaxBitRateUplink(uint64_t bitRate);
 
    uint32_t GetLengthOfIes() const;
    uint32_t GetNumberOfIes() const;
 
  private:
    uint32_t m_numberOfIes;  
    uint32_t m_headerLength; 
 
    uint16_t m_oldGnbUeX2apId;                
    uint16_t m_cause;                         
    uint16_t m_targetCellId;                  
    uint32_t m_mmeUeS1apId;                   
    uint64_t m_ueAggregateMaxBitRateDownlink; 
    uint64_t m_ueAggregateMaxBitRateUplink;   
    std::vector<NrEpcX2Sap::ErabToBeSetupItem> m_erabsToBeSetupList; 
};
 
class NrEpcX2HandoverRequestAckHeader : public Header
{
  public:
    NrEpcX2HandoverRequestAckHeader();
    ~NrEpcX2HandoverRequestAckHeader() override;
 
    static TypeId GetTypeId();
    TypeId GetInstanceTypeId() const override;
    uint32_t GetSerializedSize() const override;
    void Serialize(Buffer::Iterator start) const override;
    uint32_t Deserialize(Buffer::Iterator start) override;
    void Print(std::ostream& os) const override;
 
    uint16_t GetOldGnbUeX2apId() const;
    void SetOldGnbUeX2apId(uint16_t x2apId);
 
    uint16_t GetNewGnbUeX2apId() const;
    void SetNewGnbUeX2apId(uint16_t x2apId);
 
    std::vector<NrEpcX2Sap::ErabAdmittedItem> GetAdmittedBearers() const;
    void SetAdmittedBearers(std::vector<NrEpcX2Sap::ErabAdmittedItem> bearers);
 
    std::vector<NrEpcX2Sap::ErabNotAdmittedItem> GetNotAdmittedBearers() const;
    void SetNotAdmittedBearers(std::vector<NrEpcX2Sap::ErabNotAdmittedItem> bearers);
 
    uint32_t GetLengthOfIes() const;
    uint32_t GetNumberOfIes() const;
 
  private:
    uint32_t m_numberOfIes;  
    uint32_t m_headerLength; 
 
    uint16_t m_oldGnbUeX2apId;                                     
    uint16_t m_newGnbUeX2apId;                                     
    std::vector<NrEpcX2Sap::ErabAdmittedItem> m_erabsAdmittedList; 
    std::vector<NrEpcX2Sap::ErabNotAdmittedItem>
        m_erabsNotAdmittedList; 
};
 
class NrEpcX2HandoverPreparationFailureHeader : public Header
{
  public:
    NrEpcX2HandoverPreparationFailureHeader();
    ~NrEpcX2HandoverPreparationFailureHeader() override;
 
    static TypeId GetTypeId();
    TypeId GetInstanceTypeId() const override;
    uint32_t GetSerializedSize() const override;
    void Serialize(Buffer::Iterator start) const override;
    uint32_t Deserialize(Buffer::Iterator start) override;
    void Print(std::ostream& os) const override;
 
    uint16_t GetOldGnbUeX2apId() const;
    void SetOldGnbUeX2apId(uint16_t x2apId);
 
    uint16_t GetCause() const;
    void SetCause(uint16_t cause);
 
    uint16_t GetCriticalityDiagnostics() const;
    void SetCriticalityDiagnostics(uint16_t criticalityDiagnostics);
 
    uint32_t GetLengthOfIes() const;
    uint32_t GetNumberOfIes() const;
 
  private:
    uint32_t m_numberOfIes;  
    uint32_t m_headerLength; 
 
    uint16_t m_oldGnbUeX2apId;         
    uint16_t m_cause;                  
    uint16_t m_criticalityDiagnostics; 
};
 
class NrEpcX2SnStatusTransferHeader : public Header
{
  public:
    NrEpcX2SnStatusTransferHeader();
    ~NrEpcX2SnStatusTransferHeader() override;
 
    static TypeId GetTypeId();
    TypeId GetInstanceTypeId() const override;
    uint32_t GetSerializedSize() const override;
    void Serialize(Buffer::Iterator start) const override;
    uint32_t Deserialize(Buffer::Iterator start) override;
    void Print(std::ostream& os) const override;
 
    uint16_t GetOldGnbUeX2apId() const;
    void SetOldGnbUeX2apId(uint16_t x2apId);
 
    uint16_t GetNewGnbUeX2apId() const;
    void SetNewGnbUeX2apId(uint16_t x2apId);
 
    std::vector<NrEpcX2Sap::ErabsSubjectToStatusTransferItem> GetErabsSubjectToStatusTransferList()
        const;
    void SetErabsSubjectToStatusTransferList(
        std::vector<NrEpcX2Sap::ErabsSubjectToStatusTransferItem> erabs);
 
    uint32_t GetLengthOfIes() const;
    uint32_t GetNumberOfIes() const;
 
  private:
    uint32_t m_numberOfIes;  
    uint32_t m_headerLength; 
 
    uint16_t m_oldGnbUeX2apId; 
    uint16_t m_newGnbUeX2apId; 
    std::vector<NrEpcX2Sap::ErabsSubjectToStatusTransferItem>
        m_erabsSubjectToStatusTransferList; 
};
 
class NrEpcX2UeContextReleaseHeader : public Header
{
  public:
    NrEpcX2UeContextReleaseHeader();
    ~NrEpcX2UeContextReleaseHeader() override;
 
    static TypeId GetTypeId();
    TypeId GetInstanceTypeId() const override;
    uint32_t GetSerializedSize() const override;
    void Serialize(Buffer::Iterator start) const override;
    uint32_t Deserialize(Buffer::Iterator start) override;
    void Print(std::ostream& os) const override;
 
    uint16_t GetOldGnbUeX2apId() const;
    void SetOldGnbUeX2apId(uint16_t x2apId);
 
    uint16_t GetNewGnbUeX2apId() const;
    void SetNewGnbUeX2apId(uint16_t x2apId);
 
    uint32_t GetLengthOfIes() const;
    uint32_t GetNumberOfIes() const;
 
  private:
    uint32_t m_numberOfIes;  
    uint32_t m_headerLength; 
 
    uint16_t m_oldGnbUeX2apId; 
    uint16_t m_newGnbUeX2apId; 
};
 
class NrEpcX2LoadInformationHeader : public Header
{
  public:
    NrEpcX2LoadInformationHeader();
    ~NrEpcX2LoadInformationHeader() override;
 
    static TypeId GetTypeId();
    TypeId GetInstanceTypeId() const override;
    uint32_t GetSerializedSize() const override;
    void Serialize(Buffer::Iterator start) const override;
    uint32_t Deserialize(Buffer::Iterator start) override;
    void Print(std::ostream& os) const override;
 
    std::vector<NrEpcX2Sap::CellInformationItem> GetCellInformationList() const;
    void SetCellInformationList(std::vector<NrEpcX2Sap::CellInformationItem> cellInformationList);
 
    uint32_t GetLengthOfIes() const;
    uint32_t GetNumberOfIes() const;
 
  private:
    uint32_t m_numberOfIes;  
    uint32_t m_headerLength; 
 
    std::vector<NrEpcX2Sap::CellInformationItem> m_cellInformationList; 
};
 
class NrEpcX2ResourceStatusUpdateHeader : public Header
{
  public:
    NrEpcX2ResourceStatusUpdateHeader();
    ~NrEpcX2ResourceStatusUpdateHeader() override;
 
    static TypeId GetTypeId();
    TypeId GetInstanceTypeId() const override;
    uint32_t GetSerializedSize() const override;
    void Serialize(Buffer::Iterator start) const override;
    uint32_t Deserialize(Buffer::Iterator start) override;
    void Print(std::ostream& os) const override;
 
    uint16_t GetGnb1MeasurementId() const;
    void SetGnb1MeasurementId(uint16_t gnb1MeasurementId);
 
    uint16_t GetGnb2MeasurementId() const;
    void SetGnb2MeasurementId(uint16_t gnb2MeasurementId);
 
    std::vector<NrEpcX2Sap::CellMeasurementResultItem> GetCellMeasurementResultList() const;
    void SetCellMeasurementResultList(
        std::vector<NrEpcX2Sap::CellMeasurementResultItem> cellMeasurementResultList);
 
    uint32_t GetLengthOfIes() const;
    uint32_t GetNumberOfIes() const;
 
  private:
    uint32_t m_numberOfIes;  
    uint32_t m_headerLength; 
 
    uint16_t m_gnb1MeasurementId; 
    uint16_t m_gnb2MeasurementId; 
    std::vector<NrEpcX2Sap::CellMeasurementResultItem>
        m_cellMeasurementResultList; 
};
 
class NrEpcX2HandoverCancelHeader : public Header
{
  public:
    NrEpcX2HandoverCancelHeader();
    ~NrEpcX2HandoverCancelHeader() override;
 
    static TypeId GetTypeId();
    TypeId GetInstanceTypeId() const override;
    uint32_t GetSerializedSize() const override;
    void Serialize(Buffer::Iterator start) const override;
    uint32_t Deserialize(Buffer::Iterator start) override;
    void Print(std::ostream& os) const override;
 
    uint16_t GetOldGnbUeX2apId() const;
    void SetOldGnbUeX2apId(uint16_t x2apId);
 
    uint16_t GetNewGnbUeX2apId() const;
    void SetNewGnbUeX2apId(uint16_t x2apId);
 
    uint16_t GetCause() const;
    void SetCause(uint16_t cause);
 
    uint32_t GetLengthOfIes() const;
    uint32_t GetNumberOfIes() const;
 
  private:
    uint32_t m_numberOfIes;  
    uint32_t m_headerLength; 
 
    uint16_t m_oldGnbUeX2apId; 
    uint16_t m_newGnbUeX2apId; 
    uint16_t m_cause;          
};
 
} // namespace ns3
 
#endif // NR_EPC_X2_HEADER_H