lorawan-mac.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2017 University of Padova
 *
 * 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: Davide Magrin <magrinda@dei.unipd.it>
 *
 * Modified by: Bastien Tauran <bastien.tauran@viveris.fr>
 */
 
#ifndef LORAWAN_MAC_H
#define LORAWAN_MAC_H
 
#include "lora-logical-channel-helper.h"
#include "satellite-lora-phy-rx.h"
#include "satellite-mac.h"
#include "satellite-phy.h"
 
#include <ns3/object.h>
#include <ns3/packet.h>
 
#include <array>
#include <stdint.h>
#include <vector>
 
namespace ns3
{
 
class LorawanMac : public SatMac
{
  public:
    static TypeId GetTypeId(void);
 
    LorawanMac();
    LorawanMac(uint32_t satId, uint32_t beamId);
    virtual ~LorawanMac();
 
    typedef std::array<std::array<uint8_t, 6>, 8> ReplyDataRateMatrix;
 
    Ptr<SatPhy> GetPhy(void);
 
    void SetPhy(Ptr<SatPhy> phy);
 
    Ptr<SatLoraPhyTx> GetPhyTx(void);
 
    void SetPhyTx(Ptr<SatLoraPhyTx> phyTx);
 
    virtual void Send(Ptr<Packet> packet, const Address& dest, uint16_t protocolNumber);
 
    virtual void Send(Ptr<Packet> packet) = 0;
 
    virtual void Receive(SatPhy::PacketContainer_t packets,
                         Ptr<SatSignalParameters> /*rxParams*/) = 0;
 
    virtual void FailedReception(Ptr<const Packet> packet) = 0;
 
    virtual void TxFinished() = 0;
 
    void SetDevice(Ptr<NetDevice> device);
 
    Ptr<NetDevice> GetDevice(void);
 
    LoraLogicalChannelHelper GetLoraLogicalChannelHelper(void);
 
    void SetLoraLogicalChannelHelper(LoraLogicalChannelHelper helper);
 
    uint8_t GetSfFromDataRate(uint8_t dataRate);
 
    double GetBandwidthFromDataRate(uint8_t dataRate);
 
    double GetDbmForTxPower(uint8_t txPower);
 
    Time GetOnAirTime(Ptr<Packet> packet, LoraTxParameters txParams);
 
    void SetSfForDataRate(std::vector<uint8_t> sfForDataRate);
 
    void SetBandwidthForDataRate(std::vector<double> bandwidthForDataRate);
 
    void SetMaxAppPayloadForDataRate(std::vector<uint32_t> maxAppPayloadForDataRate);
 
    void SetTxDbmForTxPower(std::vector<double> txDbmForTxPower);
 
    void SetReplyDataRateMatrix(ReplyDataRateMatrix replyDataRateMatrix);
 
    void SetNPreambleSymbols(int nPreambleSymbols);
 
    int GetNPreambleSymbols(void);
 
    void setRegenerative(bool isRegenerative);
 
  protected:
    TracedCallback<Ptr<const Packet>> m_cannotSendBecauseDutyCycle;
 
    TracedCallback<Ptr<const Packet>> m_receivedPacket;
 
    TracedCallback<Ptr<const Packet>> m_sentNewPacket;
 
    Ptr<SatPhy> m_phy;
 
    Ptr<NetDevice> m_device;
 
    LoraLogicalChannelHelper m_channelHelper;
 
    std::vector<uint8_t> m_sfForDataRate;
 
    std::vector<double> m_bandwidthForDataRate;
 
    std::vector<uint32_t> m_maxAppPayloadForDataRate;
 
    int m_nPreambleSymbols;
 
    std::vector<double> m_txDbmForTxPower;
 
    ReplyDataRateMatrix m_replyDataRateMatrix;
 
    uint32_t m_beamId;
 
    bool m_isRegenerative;
};
 
} /* namespace ns3 */
 
#endif /* LORAWAN_MAC_H */