/usr/include/ns3.26/ns3/spectrum-channel.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 | /* -*- 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_CHANNEL_H
#define SPECTRUM_CHANNEL_H
#include <ns3/object.h>
#include <ns3/nstime.h>
#include <ns3/channel.h>
#include <ns3/spectrum-signal-parameters.h>
namespace ns3 {
class PacketBurst;
class SpectrumValue;
class SpectrumPhy;
class SpectrumPropagationLossModel;
class PropagationLossModel;
class PropagationDelayModel;
/**
* \ingroup spectrum
*
* Defines the interface for spectrum-aware channel implementations
*
*/
class SpectrumChannel : public Channel
{
public:
virtual ~SpectrumChannel ();
/**
* \brief Get the type ID.
* \return the object TypeId
*/
static TypeId GetTypeId (void);
/**
* Set the single-frequency propagation loss model to be used
* \warning only models that do not depend on the TX power should be used.
*
* \param loss a pointer to the propagation loss model to be used.
*/
virtual void AddPropagationLossModel (Ptr<PropagationLossModel> loss) = 0;
/**
* Set the frequency-dependent propagation loss model to be used
* \param loss a pointer to the propagation loss model to be used.
*/
virtual void AddSpectrumPropagationLossModel (Ptr<SpectrumPropagationLossModel> loss) = 0;
/**
* Set the propagation delay model to be used
* \param delay Ptr to the propagation delay model to be used.
*/
virtual void SetPropagationDelayModel (Ptr<PropagationDelayModel> delay) = 0;
/**
* Used by attached PHY instances to transmit signals on the channel
*
* @param params the parameters of the signals being transmitted
*/
virtual void StartTx (Ptr<SpectrumSignalParameters> params) = 0;
/**
* @brief Add a SpectrumPhy to a channel, so it can receive packets
*
* This method is used to attach a SpectrumPhy instance to a
* SpectrumChannel instance, so that the SpectrumPhy can receive
* packets sent on that channel. Note that a SpectrumPhy that only
* transmits (without receiveing ever) does not need to be added to
* the channel.
*
* This method is to be implemented by all classes inheriting from
* SpectrumChannel.
*
* @param phy the SpectrumPhy instance to be added to the channel as
* a receiver.
*/
virtual void AddRx (Ptr<SpectrumPhy> phy) = 0;
/**
* TracedCallback signature for path loss calculation events.
*
* \param [in] txPhy The TX SpectrumPhy instance.
* \param [in] rxPhy The RX SpectrumPhy instance.
* \param [in] lossDb The loss value, in dB.
* \deprecated The non-const `Ptr<SpectrumValue>` is
* deprecated and will be changed to Ptr<const SpectrumValue>`
* in a future release.
*/
typedef void (* LossTracedCallback)
(Ptr<SpectrumPhy> txPhy, Ptr<SpectrumPhy> rxPhy,
double lossDb);
};
}
#endif /* SPECTRUM_CHANNEL_H */
|