|
A Discrete-Event Network Simulator
|
API |
|
|
A Discrete-Event Network Simulator
|
API |
This section documents the API of the ns-3 UAN module. More...
Modules | |
| uan module tests | |
Files | |
| file | uan-animation.cc |
| This example showcases the "CW-MAC" described in System Design Considerations for Undersea Networks article in the IEEE Journal on Selected Areas of Communications 2008 by Nathan Parrish, Leonard Tracy and Sumit Roy. | |
| file | uan-cw-example.cc |
| This example showcases the "CW-MAC" described in System Design Considerations for Undersea Networks article in the IEEE Journal on Selected Areas of Communications 2008 by Nathan Parrish, Leonard Tracy and Sumit Roy. | |
Classes | |
| struct | ns3::UanMacRcGw::AckData |
| Packet ACK data. More... | |
| class | ns3::AcousticModemEnergyModel |
| WHOI micro-modem energy model. More... | |
| class | ns3::AcousticModemEnergyModelHelper |
| Assign AcousticModemEnergyModel to uan devices. More... | |
| class | Experiment |
| Helper class for UAN CW MAC example. More... | |
| struct | ns3::UanMacRcGw::Request |
| Reservation request. More... | |
| class | ns3::Tap |
| Holds PDP Tap information (amplitude and delay) More... | |
| class | ns3::UanChannel |
| Channel class used by UAN devices. More... | |
| class | ns3::UanHeaderCommon |
| Common packet header fields. More... | |
| class | ns3::UanHeaderRcAck |
| Header used for ACK packets by protocol UanMacRc. More... | |
| class | ns3::UanHeaderRcCts |
| CTS header. More... | |
| class | ns3::UanHeaderRcCtsGlobal |
| Cycle broadcast information. More... | |
| class | ns3::UanHeaderRcData |
| Extra data header information. More... | |
| class | ns3::UanHeaderRcRts |
| RTS header. More... | |
| class | ns3::UanHelper |
| UAN configuration helper. More... | |
| class | ns3::UanMac |
| Virtual base class for all UAN MAC protocols. More... | |
| class | ns3::UanMacAloha |
| ALOHA MAC Protocol, the simplest MAC protocol for wireless networks. More... | |
| class | ns3::UanMacCw |
| CW-MAC protocol, similar in idea to the 802.11 DCF with constant backoff window. More... | |
| class | ns3::UanMacRc |
| Non-gateway node MAC for reservation channel MAC protocol. More... | |
| class | ns3::UanMacRcGw |
| Gateway side of RC-MAC. More... | |
| class | ns3::UanModesList |
| Container for UanTxModes. More... | |
| class | ns3::UanNetDevice |
| Net device for UAN models. More... | |
| class | ns3::UanNoiseModel |
| UAN Noise Model base class. More... | |
| class | ns3::UanNoiseModelDefault |
| Standard ambient acoustic noise model. More... | |
| class | ns3::UanPacketArrival |
| Class consisting of packet arrival information (Time, RxPower, mode, PDP). More... | |
| class | ns3::UanPdp |
| The power delay profile returned by propagation models. More... | |
| class | ns3::UanPhy |
| Base class for UAN Phy models. More... | |
| class | ns3::UanPhyCalcSinr |
| Class used for calculating SINR of packet in UanPhy. More... | |
| class | ns3::UanPhyCalcSinrDefault |
| Default SINR calculator for UanPhyGen. More... | |
| class | ns3::UanPhyCalcSinrFhFsk |
| WHOI Micromodem like FH-FSK model. More... | |
| class | ns3::UanPhyDual |
| Two channel Phy. More... | |
| class | ns3::UanPhyGen |
| Generic PHY model. More... | |
| class | ns3::UanPhyListener |
| Interface for PHY event listener. More... | |
| class | ns3::UanPhyPer |
| Calculate packet error probability, based on received SINR and modulation (mode). More... | |
| class | ns3::UanPhyPerCommonModes |
| Packet error rate calculation for common tx modes based on UanPhyPerUmodem. More... | |
| class | ns3::UanPhyPerGenDefault |
| Default Packet Error Rate calculator for UanPhyGen. More... | |
| class | ns3::UanPhyPerUmodem |
| Packet error rate calculation assuming WHOI Micromodem-like PHY (FH-FSK) More... | |
| class | ns3::UanPropModel |
| Base class for implemented underwater propagation models. More... | |
| class | ns3::UanPropModelIdeal |
| Ideal propagation model (no pathloss, impulse PDP). More... | |
| class | ns3::UanPropModelThorp |
| Uses Thorp's approximation to compute pathloss. More... | |
| class | ns3::UanTransducer |
| Virtual base for Transducer objects. More... | |
| class | ns3::UanTransducerHd |
| Half duplex implementation of transducer object. More... | |
| class | ns3::UanTxMode |
| Abstraction of packet modulation information. More... | |
| class | ns3::UanTxModeFactory |
| Global database of UanTxMode objects, retrievable by id or name. More... | |
| struct | ns3::UanTxModeFactory::UanTxModeItem |
| Container for the UanTxMode properties. More... | |
Functions | |
| std::ostream & | ns3::operator<< (std::ostream &os, const UanPdp &pdp) |
| Writes PDP to stream as list of arrivals. More... | |
| std::istream & | ns3::operator>> (std::istream &is, UanPdp &pdp) |
| Reads in list of arrivals from stream is. More... | |
This section documents the API of the ns-3 UAN module.
For a generic functional description, please refer to the ns-3 manual.
| std::ostream & ns3::operator<< | ( | std::ostream & | os, |
| const UanPdp & | pdp | ||
| ) |
Writes PDP to stream as list of arrivals.
| os | The output stream. |
| pdp | The PDP. |
Definition at line 30 of file uan-prop-model.cc.
References ns3::UanPdp::GetNTaps(), ns3::UanPdp::GetResolution(), ns3::Time::GetSeconds(), and ns3::UanPdp::m_taps.
| std::istream & ns3::operator>> | ( | std::istream & | is, |
| UanPdp & | pdp | ||
| ) |
Reads in list of arrivals from stream is.
| is | The input stream. |
| pdp | The PDP variable to set. |
Definition at line 44 of file uan-prop-model.cc.
References ns3::UanPdp::m_resolution, ns3::UanPdp::m_taps, NS_FATAL_ERROR, and ns3::Seconds().
1.8.14