/usr/include/ns3.26/ns3/spectrum-phy.h is in libns3-dev 3.26+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* 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/object.h>
#include <ns3/nstime.h>
namespace ns3 {
class PacketBurst;
class SpectrumChannel;
class MobilityModel;
class AntennaModel;
class SpectrumValue;
class SpectrumModel;
class NetDevice;
struct SpectrumSignalParameters;
/**
* \ingroup spectrum
*
* Abstract base class for Spectrum-aware PHY layers
*
*/
class SpectrumPhy : public Object
{
public:
SpectrumPhy ();
virtual ~SpectrumPhy ();
/**
* \brief Get the type ID.
* \return the object TypeId
*/
static TypeId GetTypeId (void);
/**
* 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 () = 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;
/**
* Get the AntennaModel used by the NetDevice for reception
*
* @return a Ptr to the AntennaModel used by the NetDevice for reception
*/
virtual Ptr<AntennaModel> GetRxAntenna () = 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;
private:
/**
* \brief Copy constructor
*
* Defined and unimplemented to avoid misuse
*/
SpectrumPhy (SpectrumPhy const &);
/**
* \brief Copy constructor
*
* Defined and unimplemented to avoid misuse
* \returns
*/
SpectrumPhy& operator= (SpectrumPhy const &);
};
} // namespace ns3
#endif /* SPECTRUM_PHY_H */
|