lora-frame-header.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>
 */
 
#ifndef LORA_FRAME_HEADER_H
#define LORA_FRAME_HEADER_H
 
#include "lora-device-address.h"
#include "lorawan-mac-command.h"
 
#include "ns3/header.h"
 
#include <list>
#include <ostream>
#include <stdint.h>
 
namespace ns3
{

class LoraFrameHeader : public Header
{
  public:
    LoraFrameHeader();
    ~LoraFrameHeader();
 
    // Methods inherited from Header
    static TypeId GetTypeId(void);
    virtual TypeId GetInstanceTypeId(void) const;

    virtual uint32_t GetSerializedSize(void) const;

    virtual void Serialize(Buffer::Iterator start) const;

    virtual uint32_t Deserialize(Buffer::Iterator start);

    virtual void Print(std::ostream& os) const;

    void SetAsUplink(void);

    void SetAsDownlink(void);

    void SetFPort(uint8_t fPort);

    uint8_t GetFPort(void) const;

    void SetAddress(LoraDeviceAddress address);

    LoraDeviceAddress GetAddress(void) const;

    void SetAdr(bool adr);

    bool GetAdr(void) const;

    void SetAdrAckReq(bool adrAckReq);

    bool GetAdrAckReq(void) const;

    void SetAck(bool ack);

    bool GetAck(void) const;

    void SetFPending(bool fPending);

    bool GetFPending(void) const;

    uint8_t GetFOptsLen(void) const;

    void SetFCnt(uint16_t fCnt);
    uint16_t GetFCnt(void) const;

    template <typename T>
    inline Ptr<T> GetLorawanMacCommand(void);

    void AddLinkCheckReq(void);

    void AddLinkCheckAns(uint8_t margin, uint8_t gwCnt);

    void AddLinkAdrReq(uint8_t dataRate,
                       uint8_t txPower,
                       std::list<int> enabledChannels,
                       int repetitions);

    void AddLinkAdrAns(bool powerAck, bool dataRateAck, bool channelMaskAck);

    void AddDutyCycleReq(uint8_t dutyCycle);

    void AddDutyCycleAns(void);

    void AddRxParamSetupReq(uint8_t rx1DrOffset, uint8_t rx2DataRate, double frequency);

    void AddRxParamSetupAns();

    void AddDevStatusReq();

    void AddNewChannelReq(uint8_t chIndex,
                          double frequency,
                          uint8_t minDataRate,
                          uint8_t maxDataRate);

    std::list<Ptr<LorawanMacCommand>> GetCommands(void);

    void AddCommand(Ptr<LorawanMacCommand> macCommand);
 
  private:
    uint8_t m_fPort;
 
    LoraDeviceAddress m_address;
 
    bool m_adr;
    bool m_adrAckReq;
    bool m_ack;
    bool m_fPending;
    uint8_t m_fOptsLen;
 
    uint16_t m_fCnt;
 
    Buffer m_fOpts;

    std::list<Ptr<LorawanMacCommand>> m_macCommands;
 
    bool m_isUplink;
};
 
template <typename T>
Ptr<T>
LoraFrameHeader::GetLorawanMacCommand()
{
    // Iterate on MAC commands and try casting
    std::list<Ptr<LorawanMacCommand>>::const_iterator it;
    for (it = m_macCommands.begin(); it != m_macCommands.end(); ++it)
    {
        if ((*it)->GetObject<T>() != nullptr)
        {
            return (*it)->GetObject<T>();
        }
    }
 
    // If no command was found, return 0
    return 0;
}
} // namespace ns3
 
#endif