sub-band.h

Go to the documentation of this file.

/*
 * 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 SUB_BAND_H
#define SUB_BAND_H
 
#include "logical-lora-channel.h"
 
#include "ns3/nstime.h"
#include "ns3/object.h"
 
namespace ns3
{
namespace lorawan
{
 
class LogicalLoraChannel;
 
/**
 * \ingroup lorawan
 *
 * Class representing a SubBand, i.e., a frequency band subject to some
 * regulations on duty cycle and transmission power.
 */
class SubBand : public Object
{
  public:
    /**
     *  Register this type.
     *  \return The object TypeId.
     */
    static TypeId GetTypeId();
 
    SubBand();           //!< Default constructor
    ~SubBand() override; //!< Destructor
 
    /**
     * Create a new SubBand by specifying all of its properties.
     *
     * \param firstFrequency The SubBand's lowest frequency [MHz].
     * \param lastFrequency The SubBand's highest frequency [MHz].
     * \param dutyCycle The duty cycle (as a fraction) allowed on this SubBand.
     * \param maxTxPowerDbm The maximum transmission power [dBm] allowed on this SubBand.
     */
    SubBand(double firstFrequency, double lastFrequency, double dutyCycle, double maxTxPowerDbm);
 
    /**
     * Get the lowest frequency of the SubBand.
     *
     * \return The lowest frequency [MHz] of the SubBand.
     */
    double GetFirstFrequency() const;
 
    ///**
    // * Get the last frequency of the subband.
    // *
    // * \return The lowest frequency [MHz] of the SubBand.
    // */
    // double GetLastFrequency ();
 
    /**
     * Get the duty cycle of the subband.
     *
     * \return The duty cycle (as a fraction) that needs to be enforced on this
     * SubBand.
     */
    double GetDutyCycle() const;
 
    /**
     * Update the next transmission time.
     *
     * This function is used by LogicalLoraChannelHelper, which computes the time
     * based on the SubBand's duty cycle and on the transmission duration.
     *
     * \param nextTime The future time from which transmission should be allowed
     * again.
     */
    void SetNextTransmissionTime(Time nextTime);
 
    /**
     * Returns the next time from which transmission on this subband will be
     * possible.
     *
     * \return The next time at which transmission in this SubBand will be
     * allowed.
     */
    Time GetNextTransmissionTime();
 
    /**
     * Return whether or not a frequency belongs to this SubBand.
     *
     * \param frequency The frequency [MHz] we want to test against the current subband.
     * \return True if the frequency is between firstFrequency and lastFrequency,
     * false otherwise.
     */
    bool BelongsToSubBand(double frequency) const;
 
    /**
     * Return whether or not a channel belongs to this SubBand.
     *
     * \param channel The channel we want to test against the current subband.
     * \return True if the channel's center frequency is between firstFrequency
     * and lastFrequency, false otherwise.
     */
    bool BelongsToSubBand(Ptr<LogicalLoraChannel> channel) const;
 
    /**
     * Set the maximum transmission power that is allowed on this SubBand.
     *
     * \param maxTxPowerDbm The maximum transmission power [dBm] to set.
     */
    void SetMaxTxPowerDbm(double maxTxPowerDbm);
 
    /**
     * Return the maximum transmission power that is allowed on this SubBand.
     *
     * \return The maximum transmission power, in dBm.
     */
    double GetMaxTxPowerDbm() const;
 
  private:
    double m_firstFrequency;     //!< Starting frequency of the subband, in MHz
    double m_lastFrequency;      //!< Ending frequency of the subband, in MHz
    double m_dutyCycle;          //!< The duty cycle that needs to be enforced on this subband
    Time m_nextTransmissionTime; //!< The next time a transmission will be allowed in this subband
    double m_maxTxPowerDbm; //!< The maximum transmission power that is admitted on this subband
};
} // namespace lorawan
} // namespace ns3
#endif /* SUB_BAND_H */