lorawan-mac-end-device-class-a.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>
 *         Martina Capuzzo <capuzzom@dei.unipd.it>
 *
 * Modified by: Peggy Anderson <peggy.anderson@usask.ca>
 *              Bastien Tauran <bastien.tauran@viveris.fr>
 */
 
#ifndef LORAWAN_MAC_END_DEVICE_CLASS_A_H
#define LORAWAN_MAC_END_DEVICE_CLASS_A_H
 
#include "lora-device-address.h"
#include "lora-frame-header.h"      // RxParamSetupReq
#include "lorawan-mac-end-device.h" // LorawanMacEndDevice
#include "lorawan-mac.h"            // Packet
 
#include <stdint.h>
 
namespace ns3
{

class LorawanMacEndDeviceClassA : public LorawanMacEndDevice
{
  public:
    static TypeId GetTypeId(void);
 
    LorawanMacEndDeviceClassA();
    LorawanMacEndDeviceClassA(Ptr<Node> node,
                              uint32_t satId,
                              uint32_t beamId,
                              Ptr<SatSuperframeSeq> seq);

    virtual void NotifyConstructionCompleted() override;
 
    virtual ~LorawanMacEndDeviceClassA();

    // Sending methods //

    virtual void SendToPhy(Ptr<Packet> packet);

    //  Receiving methods   //

    virtual void Receive(Ptr<Packet> packet);
 
    virtual void FailedReception(Ptr<const Packet> packet);

    virtual void TxFinished();

    void SetRaModel(SatEnums::RandomAccessModel_t randomAccessModel);

    void OpenFirstReceiveWindow(void);

    void OpenSecondReceiveWindow(void);

    void CloseFirstReceiveWindow(void);

    void CloseSecondReceiveWindow(void);

    // Getters and Setters //

    virtual Time GetNextClassTransmissionDelay(Time waitingTime);

    uint8_t GetFirstReceiveWindowDataRate(void);

    void SetSecondReceiveWindowDataRate(uint8_t dataRate);

    uint8_t GetSecondReceiveWindowDataRate(void);

    void SetSecondReceiveWindowFrequency(double frequencyMHz);

    double GetSecondReceiveWindowFrequency(void);

    // MAC command methods //

    virtual void OnRxClassParamSetupReq(Ptr<RxParamSetupReq> rxParamSetupReq);
 
  private:
    Ptr<SatSuperframeSeq> m_superframeSeq;

    SatEnums::PacketType_t m_packetType;

    Time m_firstWindowDelay;

    Time m_secondWindowDelay;

    Time m_firstWindowDuration;

    Time m_secondWindowDuration;

    EventId m_closeFirstWindow;

    EventId m_closeSecondWindow;

    EventId m_secondReceiveWindow;

    double m_secondReceiveWindowFrequency;

    uint8_t m_secondReceiveWindowDataRate;

    uint8_t m_rx1DrOffset;
 
}; /* LorawanMacEndDeviceClassA */
} /* namespace ns3 */
#endif /* LORAWAN_MAC_END_DEVICE_CLASS_A_H */