lte-as-sap.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
 *
 * 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: Nicola Baldo <nbaldo@cttc.es>
 */
 
#ifndef LTE_AS_SAP_H
#define LTE_AS_SAP_H
 
#include <ns3/packet.h>
#include <ns3/ptr.h>
 
#include <stdint.h>
 
namespace ns3
{
 
class LteAsSapProvider
{
  public:
    virtual ~LteAsSapProvider();
 
    virtual void SetCsgWhiteList(uint32_t csgId) = 0;
 
    virtual void StartCellSelection(uint32_t dlEarfcn) = 0;
 
    virtual void ForceCampedOnEnb(uint16_t cellId, uint32_t dlEarfcn) = 0;
 
    virtual void Connect() = 0;
 
    virtual void SendData(Ptr<Packet> packet, uint8_t bid) = 0;
 
    virtual void Disconnect() = 0;
};
 
class LteAsSapUser
{
  public:
    virtual ~LteAsSapUser();
 
    virtual void NotifyConnectionSuccessful() = 0;
 
    virtual void NotifyConnectionFailed() = 0;
 
    virtual void NotifyConnectionReleased() = 0;
 
    virtual void RecvData(Ptr<Packet> packet) = 0;
};
 
template <class C>
class MemberLteAsSapProvider : public LteAsSapProvider
{
  public:
    MemberLteAsSapProvider(C* owner);
 
    // Delete default constructor to avoid misuse
    MemberLteAsSapProvider() = delete;
 
    // inherited from LteAsSapProvider
    void SetCsgWhiteList(uint32_t csgId) override;
    void StartCellSelection(uint32_t dlEarfcn) override;
    void ForceCampedOnEnb(uint16_t cellId, uint32_t dlEarfcn) override;
    void Connect() override;
    void SendData(Ptr<Packet> packet, uint8_t bid) override;
    void Disconnect() override;
 
  private:
    C* m_owner; 
};
 
template <class C>
MemberLteAsSapProvider<C>::MemberLteAsSapProvider(C* owner)
    : m_owner(owner)
{
}
 
template <class C>
void
MemberLteAsSapProvider<C>::SetCsgWhiteList(uint32_t csgId)
{
    m_owner->DoSetCsgWhiteList(csgId);
}
 
template <class C>
void
MemberLteAsSapProvider<C>::StartCellSelection(uint32_t dlEarfcn)
{
    m_owner->DoStartCellSelection(dlEarfcn);
}
 
template <class C>
void
MemberLteAsSapProvider<C>::ForceCampedOnEnb(uint16_t cellId, uint32_t dlEarfcn)
{
    m_owner->DoForceCampedOnEnb(cellId, dlEarfcn);
}
 
template <class C>
void
MemberLteAsSapProvider<C>::Connect()
{
    m_owner->DoConnect();
}
 
template <class C>
void
MemberLteAsSapProvider<C>::SendData(Ptr<Packet> packet, uint8_t bid)
{
    m_owner->DoSendData(packet, bid);
}
 
template <class C>
void
MemberLteAsSapProvider<C>::Disconnect()
{
    m_owner->DoDisconnect();
}
 
template <class C>
class MemberLteAsSapUser : public LteAsSapUser
{
  public:
    MemberLteAsSapUser(C* owner);
 
    // Delete default constructor to avoid misuse
    MemberLteAsSapUser() = delete;
 
    // inherited from LteAsSapUser
    void NotifyConnectionSuccessful() override;
    void NotifyConnectionFailed() override;
    void RecvData(Ptr<Packet> packet) override;
    void NotifyConnectionReleased() override;
 
  private:
    C* m_owner; 
};
 
template <class C>
MemberLteAsSapUser<C>::MemberLteAsSapUser(C* owner)
    : m_owner(owner)
{
}
 
template <class C>
void
MemberLteAsSapUser<C>::NotifyConnectionSuccessful()
{
    m_owner->DoNotifyConnectionSuccessful();
}
 
template <class C>
void
MemberLteAsSapUser<C>::NotifyConnectionFailed()
{
    m_owner->DoNotifyConnectionFailed();
}
 
template <class C>
void
MemberLteAsSapUser<C>::RecvData(Ptr<Packet> packet)
{
    m_owner->DoRecvData(packet);
}
 
template <class C>
void
MemberLteAsSapUser<C>::NotifyConnectionReleased()
{
    m_owner->DoNotifyConnectionReleased();
}
 
} // namespace ns3
 
#endif // LTE_AS_SAP_H