spectrum-phy.h

Go to the documentation of this file.

/*
 * Copyright (c) 2009 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 SPECTRUM_PHY_H
#define SPECTRUM_PHY_H
 
#include <ns3/nstime.h>
#include <ns3/object.h>
 
namespace ns3
{
 
class PacketBurst;
class SpectrumChannel;
class MobilityModel;
class AntennaModel;
class PhasedArrayModel;
class SpectrumValue;
class SpectrumModel;
class NetDevice;
struct SpectrumSignalParameters;
 
/**
 * \ingroup spectrum
 *
 * Abstract base class for Spectrum-aware PHY layers
 *
 */
class SpectrumPhy : public Object
{
  public:
    SpectrumPhy();
    ~SpectrumPhy() override;
 
    // Delete copy constructor and assignment operator to avoid misuse
    SpectrumPhy(const SpectrumPhy&) = delete;
    SpectrumPhy& operator=(const SpectrumPhy&) = delete;
 
    /**
     * \brief Get the type ID.
     * \return the object TypeId
     */
    static TypeId GetTypeId();
 
    /**
     * Set the associated NetDevice instance
     *
     * @param d the NetDevice instance
     */
    virtual void SetDevice(Ptr<NetDevice> d) = 0;
 
    /**
     * Get the associated NetDevice instance
     *
     * @return a Ptr to the associated NetDevice instance
     */
    virtual Ptr<NetDevice> GetDevice() const = 0;
 
    /**
     * Set the mobility model associated with this device.
     *
     * @param m the mobility model
     */
    virtual void SetMobility(Ptr<MobilityModel> m) = 0;
 
    /**
     * Get the associated MobilityModel instance
     *
     * @return a Ptr to the associated MobilityModel instance
     */
    virtual Ptr<MobilityModel> GetMobility() const = 0;
 
    /**
     * Set the channel attached to this device.
     *
     * @param c the channel
     */
    virtual void SetChannel(Ptr<SpectrumChannel> c) = 0;
 
    /**
     *
     * @return returns the SpectrumModel that this SpectrumPhy expects to be used
     * for all SpectrumValues that are passed to StartRx. If 0 is
     * returned, it means that any model will be accepted.
     */
    virtual Ptr<const SpectrumModel> GetRxSpectrumModel() const = 0;
 
    /**
     * \brief Get the AntennaModel used by this SpectrumPhy instance for
     * transmission and/or reception
     *
     * Note that in general and depending on each module design, there can be
     * multiple SpectrumPhy instances per NetDevice.
     *
     * @return a Ptr to the AntennaModel used by this SpectrumPhy instance for
     * transmission and/or reception
     */
    virtual Ptr<Object> GetAntenna() const = 0;
 
    /**
     * Notify the SpectrumPhy instance of an incoming signal
     *
     * @param params the parameters of the signals being received
     */
    virtual void StartRx(Ptr<SpectrumSignalParameters> params) = 0;
};
} // namespace ns3
 
#endif /* SPECTRUM_PHY_H */