ns-3
ns3::HalfDuplexIdealPhy Class Reference

#include <half-duplex-ideal-phy.h>

Inheritance diagram for ns3::HalfDuplexIdealPhy:
Collaboration diagram for ns3::HalfDuplexIdealPhy:

List of all members.

Public Types

enum  State { IDLE, TX, RX }

Public Member Functions

void SetChannel (Ptr< SpectrumChannel > c)
void SetMobility (Ptr< MobilityModel > m)
void SetDevice (Ptr< NetDevice > d)
Ptr< MobilityModelGetMobility ()
Ptr< NetDeviceGetDevice ()
Ptr< const SpectrumModelGetRxSpectrumModel () const
void StartRx (Ptr< SpectrumSignalParameters > params)
void SetTxPowerSpectralDensity (Ptr< SpectrumValue > txPsd)
void SetNoisePowerSpectralDensity (Ptr< const SpectrumValue > noisePsd)
bool StartTx (Ptr< Packet > p)
void SetRate (DataRate rate)
DataRate GetRate () const
void SetGenericPhyTxEndCallback (GenericPhyTxEndCallback c)
void SetGenericPhyRxStartCallback (GenericPhyRxStartCallback c)
void SetGenericPhyRxEndErrorCallback (GenericPhyRxEndErrorCallback c)
void SetGenericPhyRxEndOkCallback (GenericPhyRxEndOkCallback c)

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::HalfDuplexIdealPhy.

Detailed Description

This PHY layer implementation realizes an ideal OFDM PHY which transmits half-duplex (i.e., it can either receive or transmit at a given time). The device is ideal in the sense that: 1) it uses an error model based on the Shannon capacity, which assumes ideal channel coding; 2) it uses ideal signal acquisition, i.e., preamble detection and synchronization are always successful 3) it has no PHY layer overhead

Being half duplex, if a RX is ongoing but a TX is requested, the RX is aborted and the TX is started. Of course, no RX can be performed while there is an ongoing TX.

The use of OFDM is modeled by means of the Spectrum framework. By calling the method SetTxPowerSpectralDensity(), the user can specify how much of the spectrum is used, how many subcarriers are used, and what power is allocated to each subcarrier.

The user can also specify the PHY rate at which communications take place by using SetRate(). This is equivalent to choosing a particular modulation and coding scheme.

The use of the ShannonSpectrumErrorModel allows us to account for the following aspects in determining whether a transmission is successful or not:

  • the PHY rate (trades off communication speed with reliability)
  • the power spectral density (trade-off among total power consumed, total bandwidth used (i.e., how much of the spectrum is occupied), and communication reliability)
  • the signal propagation

Member Enumeration Documentation


Member Function Documentation

get the associated NetDevice instance

Returns:
a Ptr to the associated NetDevice instance

Implements ns3::SpectrumPhy.

References NS_LOG_FUNCTION.

get the associated MobilityModel instance

Returns:
a Ptr to the associated NetDevice instance

Implements ns3::SpectrumPhy.

References NS_LOG_FUNCTION.

Returns:
the PHY rate used by this PHY.

References NS_LOG_FUNCTION.

Referenced by GetTypeId().

Returns:
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.

Implements ns3::SpectrumPhy.

References ns3::SpectrumValue::GetSpectrumModel().

This method returns the TypeId associated to ns3::HalfDuplexIdealPhy.

This object is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy/$ns3::HalfDuplexIdealPhy
  • /NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy/$ns3::SpectrumPhy/$ns3::HalfDuplexIdealPhy
  • /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy/$ns3::HalfDuplexIdealPhy
  • /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy/$ns3::SpectrumPhy/$ns3::HalfDuplexIdealPhy

Attributes defined for this type:

  • Rate: The PHY rate used by this device
    • Set with class: DataRateValue
    • Underlying type: DataRate
    • Initial value: 1000000bps
    • Flags: construct write read

TraceSources defined for this type:

  • TxStart: Trace fired when a new transmission is started
  • TxEnd: Trace fired when a previosuly started transmission is finished
  • RxStart: Trace fired when the start of a signal is detected
  • RxAbort: Trace fired when a previously started RX is aborted before time
  • RxEndOk: Trace fired when a previosuly started RX terminates successfully
  • RxEndError: Trace fired when a previosuly started RX terminates with an error (packet is corrupted)

Reimplemented from ns3::SpectrumPhy.

References GetRate(), ns3::MakeTraceSourceAccessor(), ns3::TypeId::SetParent(), and SetRate().

Set the channel attached to this device.

Parameters:
cthe channel

Implements ns3::SpectrumPhy.

References NS_LOG_FUNCTION.

set the associated NetDevice instance

Parameters:
dthe NetDevice instance

Implements ns3::SpectrumPhy.

References NS_LOG_FUNCTION.

set the callback for the end of a RX in error, as part of the interconnections betweenthe PHY and the MAC

Parameters:
cthe callback

References NS_LOG_FUNCTION.

set the callback for the successful end of a RX, as part of the interconnections betweenthe PHY and the MAC

Parameters:
cthe callback

References NS_LOG_FUNCTION.

set the callback for the start of RX, as part of the interconnections betweenthe PHY and the MAC

Parameters:
cthe callback

References NS_LOG_FUNCTION.

set the callback for the end of a TX, as part of the interconnections betweenthe PHY and the MAC

Parameters:
cthe callback

References NS_LOG_FUNCTION.

Set the mobility model associated with this device.

Parameters:
mthe mobility model

Implements ns3::SpectrumPhy.

References NS_LOG_FUNCTION.

Parameters:
noisePsdthe Noise Power Spectral Density in power units (Watt, Pascal...) per Hz.

References NS_ASSERT, NS_LOG_FUNCTION, and ns3::SpectrumInterference::SetNoisePowerSpectralDensity().

set the PHY rate to be used by this PHY.

Parameters:
rate

References NS_LOG_FUNCTION.

Referenced by GetTypeId().

set the Power Spectral Density of outgoing signals in power units (Watt, Pascal...) per Hz.

Parameters:
txPsd

References NS_ASSERT, NS_LOG_FUNCTION, and NS_LOG_INFO.

Notify the SpectrumPhy instance of an incoming signal

Parameters:
paramsthe parameters of the signals being received

Implements ns3::SpectrumPhy.

References ns3::SpectrumInterference::AddSignal(), ns3::Integral(), NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::Simulator::Schedule(), and ns3::SpectrumInterference::StartRx().

Start a transmission

Parameters:
pthe packet to be transmitted
Returns:
true if an error occurred and the transmission was not started, false otherwise.

References ns3::DataRate::CalculateTxTime(), ns3::Packet::GetSize(), ns3::Integral(), NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::Simulator::Schedule(), ns3::Seconds(), and ns3::SpectrumChannel::StartTx().

Referenced by ns3::AdhocAlohaNoackIdealPhyHelper::Install().


The documentation for this class was generated from the following files: