26 #include "ns3/simulator.h"
27 #include "ns3/traced-callback.h"
29 #include "ns3/trace-source-accessor.h"
30 #include "ns3/double.h"
31 #include "ns3/string.h"
33 #include "ns3/uan-tx-mode.h"
35 #include "ns3/uinteger.h"
36 #include "ns3/energy-source-container.h"
37 #include "ns3/acoustic-modem-energy-model.h"
64 static TypeId tid =
TypeId (
"ns3::UanPhyCalcSinrDefault")
66 .AddConstructor<UanPhyCalcSinrDefault> ()
82 NS_LOG_WARN (
"Calculating SINR for unsupported modulation type");
85 double intKp = -
DbToKp (rxPowerDb);
86 UanTransducer::ArrivalList::const_iterator it = arrivalList.begin ();
87 for (; it != arrivalList.end (); it++)
89 intKp +=
DbToKp (it->GetRxPowerDb ());
92 double totalIntDb =
KpToDb (intKp +
DbToKp (ambNoiseDb));
94 NS_LOG_DEBUG (
"Calculating SINR: RxPower = " << rxPowerDb <<
" dB. Number of interferers = " << arrivalList.size () <<
" Interference + noise power = " << totalIntDb <<
" dB. SINR = " << rxPowerDb - totalIntDb <<
" dB.");
95 return rxPowerDb - totalIntDb;
113 .AddConstructor<UanPhyCalcSinrFhFsk> ()
114 .AddAttribute (
"NumberOfHops",
115 "Number of frequencies in hopping pattern.",
118 MakeUintegerChecker<uint32_t> ())
133 NS_LOG_WARN (
"Calculating SINR for unsupported mode type");
139 double clearingTime = (
m_hops - 1.0) * ts;
144 double maxTapDelay = 0.0;
146 for (; pit != pdp.
GetEnd (); pit++)
148 if (std::abs (pit->GetAmp ()) > maxAmp)
150 maxAmp = std::abs (pit->GetAmp ());
151 maxTapDelay = pit->GetDelay ().GetSeconds ();
156 double effRxPowerDb = rxPowerDb +
KpToDb (csp);
159 UanTransducer::ArrivalList::const_iterator it = arrivalList.begin ();
160 double intKp = -
DbToKp (effRxPowerDb);
161 for (; it != arrivalList.end (); it++)
163 UanPdp intPdp = it->GetPdp ();
164 double tDelta = std::abs (arrTime.
GetSeconds () + maxTapDelay - it->GetArrivalTime ().GetSeconds ());
169 int32_t syms = (uint32_t)( (
double) tDelta / (ts + clearingTime));
170 tDelta = tDelta - syms * (ts + clearingTime);
173 if (arrTime +
Seconds (maxTapDelay) > it->GetArrivalTime ())
175 tDelta = ts + clearingTime - tDelta;
178 double intPower = 0.0;
183 Seconds (2 * ts - tDelta + clearingTime));
189 intPower += intPdp.
SumTapsNc (start, end);
191 start = start +
Seconds (ts + clearingTime);
193 intPower += intPdp.
SumTapsNc (start, end);
195 intKp +=
DbToKp (it->GetRxPowerDb ()) * intPower;
198 double totalIntDb =
KpToDb (isiUpa + intKp +
DbToKp (ambNoiseDb));
200 NS_LOG_DEBUG (
"Calculating SINR: RxPower = " << rxPowerDb <<
" dB. Effective Rx power " << effRxPowerDb <<
" dB. Number of interferers = " << arrivalList.size () <<
" Interference + noise power = " << totalIntDb <<
" dB. SINR = " << effRxPowerDb - totalIntDb <<
" dB.");
201 return effRxPowerDb - totalIntDb;
219 .AddConstructor<UanPhyPerGenDefault> ()
220 .AddAttribute (
"Threshold",
"SINR cutoff for good packet reception.",
223 MakeDoubleChecker<double> ());
257 .AddConstructor<UanPhyPerUmodem> ()
269 for (uint32_t i = std::max (k,n - k) + 1; i <= n; ++i)
274 for (uint32_t i = 2; i <= std::min (k,n - k); ++i)
286 { 12, 14, 16, 18, 20, 22, 24, 26, 28 };
289 33, 281, 2179, 15035LLU, 105166LLU, 692330LLU, 4580007LLU, 29692894LLU,
294 double ebno = std::pow (10.0, sinr / 10.0);
295 double perror = 1.0 / (2.0 + ebno);
307 for (uint32_t r = 0; r < 9; r++)
310 for (uint32_t k = 0; k < d[r]; k++)
312 sumd = sumd +
NChooseK (d[r] - 1 + k, k) * std::pow (1 - perror, (
double) k);
314 P[r] = std::pow (perror, (
double) d[r]) * sumd;
319 for (uint32_t r = 0; r < 8; r++)
321 Pb = Pb + Bd[r] * P[r];
325 uint32_t bits = pkt->
GetSize () * 8;
329 temp *= std::pow ( (1 - Pb), (
double) bits);
331 temp =
NChooseK (288, 1) * Pb * std::pow ( (1 - Pb), bits - 1.0);
360 m_pg = CreateObject<UniformRandomVariable> ();
434 .AddConstructor<UanPhyGen> ()
435 .AddAttribute (
"CcaThreshold",
436 "Aggregate energy of incoming signals to move to CCA Busy state dB.",
439 MakeDoubleChecker<double> ())
440 .AddAttribute (
"RxThreshold",
441 "Required SNR for signal acquisition in dB.",
444 MakeDoubleChecker<double> ())
445 .AddAttribute (
"TxPower",
446 "Transmission output power in dB.",
449 MakeDoubleChecker<double> ())
450 .AddAttribute (
"RxGain",
451 "Gain added to incoming signal at receiver.",
454 MakeDoubleChecker<double> ())
455 .AddAttribute (
"SupportedModes",
456 "List of modes supported by this PHY.",
460 .AddAttribute (
"PerModel",
461 "Functor to calculate PER based on SINR and TxMode.",
464 MakePointerChecker<UanPhyPer> ())
465 .AddAttribute (
"SinrModel",
466 "Functor to calculate SINR based on pkt arrivals and modes.",
469 MakePointerChecker<UanPhyCalcSinr> ())
470 .AddTraceSource (
"RxOk",
471 "A packet was received successfully.",
473 "ns3::UanPhy::TracedCallback")
474 .AddTraceSource (
"RxError",
475 "A packet was received unsuccessfully.",
477 "ns3::UanPhy::TracedCallback")
478 .AddTraceSource (
"Tx",
479 "Packet transmission beginning.",
481 "ns3::UanPhy::TracedCallback")
510 ", stopping rx/tx activities");
521 NS_LOG_DEBUG (
"Energy depleted, node cannot transmit any packet. Dropping.");
527 NS_LOG_DEBUG (
"PHY requested to TX while already Transmitting. Dropping packet.");
532 NS_LOG_DEBUG (
"PHY requested to TX while sleeping. Dropping packet.");
559 NS_LOG_DEBUG (
"Transmission ended but node sleeping or dead");
588 NS_LOG_DEBUG (
"Energy depleted, node cannot receive any packet. Dropping.");
613 bool hasmode =
false;
614 for (uint32_t i = 0; i <
GetNModes (); i++)
629 NS_LOG_DEBUG (
"PHY " <<
m_mac->GetAddress () <<
": Starting RX in IDLE mode. SINR = " << newsinr);
903 return m_sinr->CalcSinrDb (pkt, arrTime, rxPowerDb, noiseDb, mode, pdp,
m_transducer->GetArrivalList ());
912 UanTransducer::ArrivalList::const_iterator it = arrivalList.begin ();
914 double interfPower = 0;
916 for (; it != arrivalList.end (); it++)
918 if (pkt != it->GetPacket ())
920 interfPower +=
DbToKp (it->GetRxPowerDb ());
924 return KpToDb (interfPower);
931 return std::pow (10, db / 10.0);
936 return 10 * std::log10 (kp);
942 ListenerList::const_iterator it =
m_listeners.begin ();
945 (*it)->NotifyRxStart ();
952 ListenerList::const_iterator it =
m_listeners.begin ();
955 (*it)->NotifyRxEndOk ();
961 ListenerList::const_iterator it =
m_listeners.begin ();
964 (*it)->NotifyRxEndError ();
970 ListenerList::const_iterator it =
m_listeners.begin ();
973 (*it)->NotifyCcaStart ();
979 ListenerList::const_iterator it =
m_listeners.begin ();
982 (*it)->NotifyCcaEnd ();
989 ListenerList::const_iterator it =
m_listeners.begin ();
992 (*it)->NotifyTxStart (duration);
virtual void NotifyTransStartTx(Ptr< Packet > packet, double txPowerDb, UanTxMode txMode)
Called when a transmission is beginning on the attched transducer.
virtual bool IsStateBusy(void)
virtual Ptr< UanTransducer > GetTransducer(void)
Get the attached transducer.
virtual double GetRxThresholdDb(void)
Get the minimum received signal strength required to receive a packet without errors.
Simulation virtual time values and global simulation resolution.
uint32_t GetNModes(void) const
Get the number of modes in this list.
Ptr< const AttributeChecker > MakeUanModesListChecker(void)
std::vector< Tap >::const_iterator Iterator
Convenience iterator typedef.
virtual bool IsStateRx(void)
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
double KpToDb(double kp)
Convert kilopascals to dB.
void SetStream(int64_t stream)
Specifies the stream number for this RNG stream.
virtual void SetEnergyModelCallback(DeviceEnergyModel::ChangeStateCallback cb)
Set the DeviceEnergyModel callback for UanPhy device.
uint32_t m_hops
Number of hops.
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
void NotifyRxDrop(Ptr< const Packet > packet)
Called when the Phy drops a packet.
Hold variables of type string.
virtual void SetReceiveErrorCallback(RxErrCallback cb)
Set the callback to be used when a packet is received with errors.
double CalculateSinrDb(Ptr< Packet > pkt, Time arrTime, double rxPowerDb, UanTxMode mode, UanPdp pdp)
Calculate the SINR value for a packet.
virtual void EnergyDepletionHandler(void)
Handle the energy depletion event.
virtual void SetTransducer(Ptr< UanTransducer > trans)
Attach a transducer to this Phy.
bool IsNull(void) const
Check for null implementation.
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file...
virtual ~UanPhyGen()
Dummy destructor, see DoDispose.
Ptr< UniformRandomVariable > m_pg
Provides uniform random variables.
Channel is IDLE, no packet is being transmitted.
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
double m_rxRecvPwrDb
Receiver power.
double SumTapsFromMaxNc(Time delay, Time duration) const
Compute the non-coherent sum of tap amplitudes starting after a delay from the maximum amplitude for ...
uint32_t GetSize(void) const
Returns the the size in bytes of the packet (including the zero-filled initial payload).
virtual void SetSleepMode(bool sleep)
Set the Phy SLEEP mode.
virtual void StartRxPacket(Ptr< Packet > pkt, double rxPowerDb, UanTxMode txMode, UanPdp pdp)
Packet arriving from channel: i.e.
virtual uint32_t GetNModes(void)
Get the number of transmission modes supported by this Phy.
virtual void DoDispose(void)
Destructor implementation.
Container for UanTxModes.
virtual double GetTxPowerDb(void)
Get the current transmit power, in dB.
virtual double GetCcaThresholdDb(void)
Get the CCA threshold signal strength required to detect channel busy.
static EventId Schedule(Time const &time, MEM mem_ptr, OBJ obj)
Schedule an event to expire at the relative time "time" is reached.
ModulationType GetModType(void) const
Get the modulation type of the mode.
double m_rxThreshDb
Receive SINR threshold.
void NotifyRxEnd(Ptr< const Packet > packet)
Called when a packet is received without error.
static UanTxMode CreateMode(UanTxMode::ModulationType type, uint32_t dataRateBps, uint32_t phyRateSps, uint32_t cfHz, uint32_t bwHz, uint32_t constSize, std::string name)
Ptr< UanPhyPer > m_per
Error model.
virtual void DoDispose()
Destructor implementation.
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
Create a TraceSourceAccessor which will control access to the underlying trace source.
Time m_pktRxArrTime
Packet arrival time.
bool m_cleared
Flag when we've been cleared.
double GetSeconds(void) const
Get an approximation of the time stored in this instance in the indicated unit.
static TypeId GetTypeId(void)
Register this type.
double NChooseK(uint32_t n, uint32_t k)
Binomial coefficient.
static TypeId GetTypeId(void)
Register this type.
virtual double CalcSinrDb(Ptr< Packet > pkt, Time arrTime, double rxPowerDb, double ambNoiseDb, UanTxMode mode, UanPdp pdp, const UanTransducer::ArrivalList &arrivalList) const
Calculate the SINR value for a packet.
Ptr< const AttributeAccessor > MakePointerAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
virtual bool IsStateTx(void)
virtual void SetDevice(Ptr< UanNetDevice > device)
Set the device hosting this Phy.
int64_t AssignStreams(int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model...
double m_rxGainDb
Receive gain.
uint32_t GetDataRateBps(void) const
Get the data rate of the transmit mode.
ns3::TracedCallback< Ptr< const Packet >, double, UanTxMode > m_rxErrLogger
A packet destined for this Phy was received with error.
virtual ~UanPhyPerUmodem()
Destructor.
Hold an unsigned integer type.
double KpToDb(double kp) const
Convert kilopascals to dB re 1 uPa.
Ptr< UanNetDevice > m_device
Device hosting this Phy.
virtual Ptr< Packet > GetPacketRx(void) const
Get the packet currently being received.
double m_txPwrDb
Transmit power.
The power delay profile returned by propagation models.
Abstraction of packet modulation information.
double m_thresh
SINR threshold.
DeviceEnergyModel::ChangeStateCallback m_energyCallback
Energy model callback.
double m_ccaThreshDb
CCA busy threshold.
void NotifyListenersRxGood(void)
Call UanListener::NotifyRxEndOk on all listeners.
void NotifyListenersCcaEnd(void)
Call UanListener::NotifyCcaEnd on all listeners.
std::list< UanPacketArrival > ArrivalList
List of arriving packets overlapping in time.
Ptr< Packet > m_pktRx
Received packet.
virtual void SetCcaThresholdDb(double thresh)
Set the threshold for detecting channel busy.
virtual void NotifyIntChange(void)
Called when there has been a change in the ammount of interference this node is experiencing from oth...
UanPdp m_pktRxPdp
Power delay profile of pakket.
virtual double CalcSinrDb(Ptr< Packet > pkt, Time arrTime, double rxPowerDb, double ambNoiseDb, UanTxMode mode, UanPdp pdp, const UanTransducer::ArrivalList &arrivalList) const
Calculate the SINR value for a packet.
virtual Ptr< UanChannel > GetChannel(void) const
Get the attached channel.
Ptr< UanPhyCalcSinr > m_sinr
SINR calculator.
virtual UanTxMode GetMode(uint32_t n)
Get a specific transmission mode.
virtual void SetRxThresholdDb(double thresh)
Set the minimum SINR threshold to receive a packet without errors.
void NotifyRxBegin(Ptr< const Packet > packet)
Called when the Phy begins to receive a packet.
void TxEndEvent()
Event to process end of packet transmission.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
double DbToKp(double db)
Convert dB to kilopascals.
virtual void SetRxGainDb(double gain)
Set the receiver gain.
RxOkCallback m_recOkCb
Callback for packets received without error.
UanModesList m_modes
List of modes supported by this PHY.
uint32_t GetCenterFreqHz(void) const
Get the transmission center frequency.
Interface for PHY event listener.
static TypeId GetTypeId(void)
Register this type.
void UpdatePowerConsumption(const State state)
Update energy source with new state.
void NotifyListenersRxStart(void)
Call UanListener::NotifyRxStart on all listeners.
virtual double CalcPer(Ptr< Packet > pkt, double sinrDb, UanTxMode mode)
Calculate the packet error probability based on SINR at the receiver and a tx mode.
virtual ~UanPhyCalcSinrFhFsk()
Destructor.
void RxEndEvent(Ptr< Packet > pkt, double rxPowerDb, UanTxMode txMode)
Event to process end of packet reception.
double DbToKp(double db) const
Convert dB re 1 uPa to kilopascals.
static Time Now(void)
Return the current simulation virtual time.
virtual void SetChannel(Ptr< UanChannel > channel)
Attach to a channel.
Ptr< UanMac > m_mac
MAC layer.
Iterator GetEnd(void) const
Get the end of the tap list (one beyond the last entry).
Base class for UAN Phy models.
Ptr< const AttributeAccessor > MakeDoubleAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
uint32_t GetPhyRateSps(void) const
Get the physical signaling rate.
virtual ~UanPhyPerGenDefault()
Destructor.
UanPhyCalcSinrFhFsk()
Constructor.
bool m_disabled
Energy depleted.
#define NS_LOG_WARN(msg)
Use NS_LOG to output a message of level LOG_WARN.
ns3::TracedCallback< Ptr< const Packet >, double, UanTxMode > m_txLogger
A packet was sent from this Phy.
virtual bool IsStateIdle(void)
RxErrCallback m_recErrCb
Callback for packets received with errors.
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
static TypeId GetTypeId(void)
Register this type.
Ptr< UanChannel > m_channel
Attached channel.
void NotifyListenersCcaStart(void)
Call UanListener::NotifyCcaStart on all listeners.
Time Seconds(double value)
Construct a Time in the indicated unit.
void AppendMode(UanTxMode mode)
Add mode to this list.
double GetInterferenceDb(Ptr< Packet > pkt)
Calculate interference power from overlapping packet arrivals, in dB.
void NotifyListenersRxBad(void)
Call UanListener::NotifyRxEndError on all listeners.
Ptr< UanTransducer > m_transducer
Associated transducer.
void Nullify(void)
Discard the implementation, set it to null.
UanPhyPerUmodem()
Constructor.
UanPhyPerGenDefault()
Constructor.
Ptr< const AttributeAccessor > MakeUanModesListAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
static TypeId GetTypeId(void)
Register this type.
virtual ~UanPhyCalcSinrDefault()
Destructor.
A base class which provides memory management and object aggregation.
uint32_t GetBandwidthHz(void) const
Get the transmission signal bandwidth.
virtual void SendPacket(Ptr< Packet > pkt, uint32_t modeNum)
Send a packet using a specific transmission mode.
Iterator GetBegin(void) const
Get the beginning of the tap vector.
UanTxMode m_pktRxMode
Packet transmission mode at receiver.
ListenerList m_listeners
List of listeners.
virtual bool IsStateCcaBusy(void)
virtual void RegisterListener(UanPhyListener *listener)
Register a UanPhyListener to be notified of common UanPhy events.
virtual double GetRxGainDb(void)
Get the receiver gain added to signal at receiver in dB.
double m_minRxSinrDb
Minimum receive SINR during packet reception.
This class can be used to hold variables of floating point type such as 'double' or 'float'...
virtual bool IsStateSleep(void)
virtual void SetMac(Ptr< UanMac > mac)
Set the MAC forwarding messages to this Phy.
virtual void SetReceiveOkCallback(RxOkCallback cb)
Set the callback to be used when a packet is received without error.
uint32_t GetUid(void) const
Get a unique id for the mode.
double SumTapsNc(Time begin, Time end) const
Compute the non-coherent sum of tap amplitudes between a start and end time.
Ptr< const AttributeAccessor > MakeUintegerAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
static UanModesList GetDefaultModes(void)
Get the default transmission modes.
a unique identifier for an interface.
virtual double CalcPer(Ptr< Packet > pkt, double sinrDb, UanTxMode mode)
Calculate the packet error probability based on SINR at the receiver and a tx mode.
virtual Ptr< UanNetDevice > GetDevice(void)
Get the device hosting this Phy.
TypeId SetParent(TypeId tid)
virtual void Clear(void)
Clear all pointer references.
UanPhyCalcSinrDefault()
Constructor.
ns3::TracedCallback< Ptr< const Packet >, double, UanTxMode > m_rxOkLogger
A packet destined for this Phy was received without error.
void NotifyListenersTxStart(Time duration)
Call UanListener::NotifyTxStart on all listeners.
AttributeValue implementation for UanModesList.
virtual void SetTxPowerDb(double txpwr)
Set the transmit power.