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). More...
#include "half-duplex-ideal-phy.h"
Public Types | |
enum | State { IDLE , TX , RX } |
PHY states. More... | |
Public Member Functions | |
HalfDuplexIdealPhy () | |
~HalfDuplexIdealPhy () override | |
Ptr< Object > | GetAntenna () const override |
Get the AntennaModel used by this SpectrumPhy instance for transmission and/or reception. More... | |
Ptr< NetDevice > | GetDevice () const override |
Get the associated NetDevice instance. More... | |
Ptr< MobilityModel > | GetMobility () const override |
Get the associated MobilityModel instance. More... | |
DataRate | GetRate () const |
Get the PHY rate to be used by this PHY. More... | |
Ptr< const SpectrumModel > | GetRxSpectrumModel () const override |
void | SetAntenna (Ptr< AntennaModel > a) |
set the AntennaModel to be used More... | |
void | SetChannel (Ptr< SpectrumChannel > c) override |
Set the channel attached to this device. More... | |
void | SetDevice (Ptr< NetDevice > d) override |
Set the associated NetDevice instance. More... | |
void | SetGenericPhyRxEndErrorCallback (GenericPhyRxEndErrorCallback c) |
set the callback for the end of a RX in error, as part of the interconnections between the PHY and the MAC More... | |
void | SetGenericPhyRxEndOkCallback (GenericPhyRxEndOkCallback c) |
set the callback for the successful end of a RX, as part of the interconnections between the PHY and the MAC More... | |
void | SetGenericPhyRxStartCallback (GenericPhyRxStartCallback c) |
Set the callback for the start of RX, as part of the interconnections between the PHY and the MAC. More... | |
void | SetGenericPhyTxEndCallback (GenericPhyTxEndCallback c) |
Set the callback for the end of a TX, as part of the interconnections between the PHY and the MAC. More... | |
void | SetMobility (Ptr< MobilityModel > m) override |
Set the mobility model associated with this device. More... | |
void | SetNoisePowerSpectralDensity (Ptr< const SpectrumValue > noisePsd) |
Set the Noise Power Spectral Density in power units (Watt, Pascal...) per Hz. More... | |
void | SetRate (DataRate rate) |
Set the PHY rate to be used by this PHY. More... | |
void | SetTxPowerSpectralDensity (Ptr< SpectrumValue > txPsd) |
Set the Power Spectral Density of outgoing signals in power units (Watt, Pascal...) per Hz. More... | |
void | StartRx (Ptr< SpectrumSignalParameters > params) override |
Notify the SpectrumPhy instance of an incoming signal. More... | |
bool | StartTx (Ptr< Packet > p) |
Start a transmission. More... | |
Public Member Functions inherited from ns3::SpectrumPhy | |
SpectrumPhy () | |
SpectrumPhy (const SpectrumPhy &)=delete | |
~SpectrumPhy () override | |
SpectrumPhy & | operator= (const SpectrumPhy &)=delete |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. More... | |
~Object () override | |
Destructor. More... | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. More... | |
void | Dispose () |
Dispose of this Object. More... | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. More... | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. More... | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. More... | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. More... | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. More... | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. More... | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. More... | |
bool | IsInitialized () const |
Check if the object has been initialized. More... | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. More... | |
SimpleRefCount (const SimpleRefCount &o[[maybe_unused]]) | |
Copy constructor. More... | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. More... | |
SimpleRefCount & | operator= (const SimpleRefCount &o[[maybe_unused]]) |
Assignment operator. More... | |
void | Ref () const |
Increment the reference count. More... | |
void | Unref () const |
Decrement the reference count. More... | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. More... | |
void | GetAttribute (std::string name, AttributeValue &value) const |
Get the value of an attribute, raising fatal errors if unsuccessful. More... | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. More... | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. More... | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. More... | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. More... | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. More... | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. More... | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. More... | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Get the type ID. More... | |
Static Public Member Functions inherited from ns3::SpectrumPhy | |
static TypeId | GetTypeId () |
Get the type ID. More... | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. More... | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. More... | |
Private Member Functions | |
void | AbortRx () |
About current Rx. More... | |
void | ChangeState (State newState) |
Change the PHY state. More... | |
void | DoDispose () override |
Destructor implementation. More... | |
void | EndRx () |
End current Rx. More... | |
void | EndTx () |
End the current Tx. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. More... | |
virtual void | DoInitialize () |
Initialize() implementation. More... | |
virtual void | NotifyNewAggregate () |
Notify all Objects aggregated to this one of a new Object being aggregated. More... | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. More... | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. More... | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
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:
This PHY model supports a single antenna model instance which is used for both transmission and reception.
Definition at line 78 of file half-duplex-ideal-phy.h.
PHY states.
Enumerator | |
---|---|
IDLE | Idle state. |
TX | Transmitting state. |
RX | Receiving state. |
Definition at line 87 of file half-duplex-ideal-phy.h.
ns3::HalfDuplexIdealPhy::HalfDuplexIdealPhy | ( | ) |
Definition at line 42 of file half-duplex-ideal-phy.cc.
References m_interference, and ns3::SpectrumInterference::SetErrorModel().
|
override |
Definition at line 52 of file half-duplex-ideal-phy.cc.
|
private |
About current Rx.
Definition at line 396 of file half-duplex-ideal-phy.cc.
References ns3::SpectrumInterference::AbortRx(), ns3::EventId::Cancel(), ChangeState(), IDLE, m_endRxEventId, m_interference, m_phyRxAbortTrace, m_rxPacket, m_state, NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_LOGIC, and RX.
Referenced by StartTx().
|
private |
Change the PHY state.
newState | new state |
Definition at line 265 of file half-duplex-ideal-phy.cc.
References m_state, and NS_LOG_LOGIC.
Referenced by AbortRx(), EndRx(), EndTx(), StartRx(), and StartTx().
|
overrideprivatevirtual |
Destructor implementation.
This method is called by Dispose() or by the Object's destructor, whichever comes first.
Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.
It is safe to call GetObject() from within this method.
Reimplemented from ns3::Object.
Definition at line 57 of file half-duplex-ideal-phy.cc.
References ns3::Object::DoDispose(), m_channel, m_mobility, m_netDevice, m_phyMacRxEndErrorCallback, m_phyMacRxEndOkCallback, m_phyMacRxStartCallback, m_phyMacTxEndCallback, m_rxPacket, m_rxPsd, m_txPacket, m_txPsd, and NS_LOG_FUNCTION.
|
private |
End current Rx.
Definition at line 410 of file half-duplex-ideal-phy.cc.
References ChangeState(), ns3::SpectrumInterference::EndRx(), IDLE, ns3::Callback< R, UArgs >::IsNull(), m_interference, m_phyMacRxEndErrorCallback, m_phyMacRxEndOkCallback, m_phyRxEndErrorTrace, m_phyRxEndOkTrace, m_rxPacket, m_rxPsd, m_state, NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_LOGIC, and RX.
Referenced by StartRx().
|
private |
End the current Tx.
Definition at line 311 of file half-duplex-ideal-phy.cc.
References ChangeState(), IDLE, ns3::Callback< R, UArgs >::IsNull(), m_phyMacTxEndCallback, m_phyTxEndTrace, m_state, m_txPacket, NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_LOGIC, and TX.
Referenced by StartTx().
Get the AntennaModel used by this SpectrumPhy instance for transmission and/or reception.
Note that in general and depending on each module design, there can be multiple SpectrumPhy instances per NetDevice.
Implements ns3::SpectrumPhy.
Definition at line 251 of file half-duplex-ideal-phy.cc.
References m_antenna, and NS_LOG_FUNCTION.
Get the associated NetDevice instance.
Implements ns3::SpectrumPhy.
Definition at line 144 of file half-duplex-ideal-phy.cc.
References m_netDevice, and NS_LOG_FUNCTION.
|
overridevirtual |
Get the associated MobilityModel instance.
Implements ns3::SpectrumPhy.
Definition at line 151 of file half-duplex-ideal-phy.cc.
References m_mobility, and NS_LOG_FUNCTION.
DataRate ns3::HalfDuplexIdealPhy::GetRate | ( | ) | const |
Get the PHY rate to be used by this PHY.
Definition at line 216 of file half-duplex-ideal-phy.cc.
References m_rate, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
|
overridevirtual |
Implements ns3::SpectrumPhy.
Definition at line 179 of file half-duplex-ideal-phy.cc.
References ns3::SpectrumValue::GetSpectrumModel(), and m_txPsd.
|
static |
Get the type ID.
Definition at line 102 of file half-duplex-ideal-phy.cc.
References GetRate(), m_phyRxAbortTrace, m_phyRxEndErrorTrace, m_phyRxEndOkTrace, m_phyRxStartTrace, m_phyTxEndTrace, m_phyTxStartTrace, ns3::MakeTraceSourceAccessor(), ns3::TypeId::SetParent(), and SetRate().
void ns3::HalfDuplexIdealPhy::SetAntenna | ( | Ptr< AntennaModel > | a | ) |
set the AntennaModel to be used
a | the Antenna Model |
Definition at line 258 of file half-duplex-ideal-phy.cc.
References m_antenna, and NS_LOG_FUNCTION.
|
overridevirtual |
Set the channel attached to this device.
c | the channel |
Implements ns3::SpectrumPhy.
Definition at line 172 of file half-duplex-ideal-phy.cc.
References m_channel, and NS_LOG_FUNCTION.
Set the associated NetDevice instance.
d | the NetDevice instance |
Implements ns3::SpectrumPhy.
Definition at line 158 of file half-duplex-ideal-phy.cc.
References m_netDevice, and NS_LOG_FUNCTION.
void ns3::HalfDuplexIdealPhy::SetGenericPhyRxEndErrorCallback | ( | GenericPhyRxEndErrorCallback | c | ) |
set the callback for the end of a RX in error, as part of the interconnections between the PHY and the MAC
c | the callback |
Definition at line 237 of file half-duplex-ideal-phy.cc.
References m_phyMacRxEndErrorCallback, and NS_LOG_FUNCTION.
void ns3::HalfDuplexIdealPhy::SetGenericPhyRxEndOkCallback | ( | GenericPhyRxEndOkCallback | c | ) |
set the callback for the successful end of a RX, as part of the interconnections between the PHY and the MAC
c | the callback |
Definition at line 244 of file half-duplex-ideal-phy.cc.
References m_phyMacRxEndOkCallback, and NS_LOG_FUNCTION.
void ns3::HalfDuplexIdealPhy::SetGenericPhyRxStartCallback | ( | GenericPhyRxStartCallback | c | ) |
Set the callback for the start of RX, as part of the interconnections between the PHY and the MAC.
c | the callback |
Definition at line 230 of file half-duplex-ideal-phy.cc.
References m_phyMacRxStartCallback, and NS_LOG_FUNCTION.
void ns3::HalfDuplexIdealPhy::SetGenericPhyTxEndCallback | ( | GenericPhyTxEndCallback | c | ) |
Set the callback for the end of a TX, as part of the interconnections between the PHY and the MAC.
c | the callback |
Definition at line 223 of file half-duplex-ideal-phy.cc.
References m_phyMacTxEndCallback, and NS_LOG_FUNCTION.
|
overridevirtual |
Set the mobility model associated with this device.
m | the mobility model |
Implements ns3::SpectrumPhy.
Definition at line 165 of file half-duplex-ideal-phy.cc.
References two-ray-to-three-gpp-ch-calibration::m, m_mobility, and NS_LOG_FUNCTION.
void ns3::HalfDuplexIdealPhy::SetNoisePowerSpectralDensity | ( | Ptr< const SpectrumValue > | noisePsd | ) |
Set the Noise Power Spectral Density in power units (Watt, Pascal...) per Hz.
noisePsd | the Noise Power Spectral Density |
Definition at line 201 of file half-duplex-ideal-phy.cc.
References m_interference, NS_ASSERT, NS_LOG_FUNCTION, and ns3::SpectrumInterference::SetNoisePowerSpectralDensity().
void ns3::HalfDuplexIdealPhy::SetRate | ( | DataRate | rate | ) |
Set the PHY rate to be used by this PHY.
rate | DataRate |
Definition at line 209 of file half-duplex-ideal-phy.cc.
References m_rate, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
void ns3::HalfDuplexIdealPhy::SetTxPowerSpectralDensity | ( | Ptr< SpectrumValue > | txPsd | ) |
Set the Power Spectral Density of outgoing signals in power units (Watt, Pascal...) per Hz.
txPsd | Tx Power Spectral Density |
Definition at line 192 of file half-duplex-ideal-phy.cc.
References m_txPsd, NS_ASSERT, NS_LOG_FUNCTION, and NS_LOG_INFO.
|
overridevirtual |
Notify the SpectrumPhy instance of an incoming signal.
params | the parameters of the signals being received |
Implements ns3::SpectrumPhy.
Definition at line 330 of file half-duplex-ideal-phy.cc.
References ns3::SpectrumInterference::AddSignal(), ChangeState(), ns3::SpectrumSignalParameters::duration, EndRx(), IDLE, ns3::Integral(), ns3::Callback< R, UArgs >::IsNull(), m_endRxEventId, m_interference, m_phyMacRxStartCallback, m_phyRxStartTrace, m_rxPacket, m_rxPsd, m_state, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::SpectrumSignalParameters::psd, RX, ns3::Simulator::Schedule(), ns3::SpectrumInterference::StartRx(), and TX.
Start a transmission.
p | the packet to be transmitted |
Definition at line 272 of file half-duplex-ideal-phy.cc.
References AbortRx(), ns3::DataRate::CalculateBytesTxTime(), ChangeState(), EndTx(), ns3::Packet::GetSize(), IDLE, ns3::Integral(), m_antenna, m_channel, m_phyTxStartTrace, m_rate, m_state, m_txPacket, m_txPsd, NS_LOG_FUNCTION, NS_LOG_LOGIC, RX, ns3::Simulator::Schedule(), and TX.
Referenced by ns3::AdhocAlohaNoackIdealPhyHelper::Install().
|
private |
Antenna model.
Definition at line 213 of file half-duplex-ideal-phy.h.
Referenced by GetAntenna(), SetAntenna(), and StartTx().
|
private |
Definition at line 215 of file half-duplex-ideal-phy.h.
Referenced by DoDispose(), SetChannel(), and StartTx().
|
private |
End Rx event.
Definition at line 210 of file half-duplex-ideal-phy.h.
|
private |
Received interference.
Definition at line 237 of file half-duplex-ideal-phy.h.
Referenced by HalfDuplexIdealPhy(), AbortRx(), EndRx(), SetNoisePowerSpectralDensity(), and StartRx().
|
private |
Mobility model.
Definition at line 212 of file half-duplex-ideal-phy.h.
Referenced by DoDispose(), GetMobility(), and SetMobility().
NetDevice connected to this phy.
Definition at line 214 of file half-duplex-ideal-phy.h.
Referenced by DoDispose(), GetDevice(), and SetDevice().
|
private |
Callback - Rx error.
Definition at line 234 of file half-duplex-ideal-phy.h.
Referenced by DoDispose(), EndRx(), and SetGenericPhyRxEndErrorCallback().
|
private |
Callback - Rx end.
Definition at line 235 of file half-duplex-ideal-phy.h.
Referenced by DoDispose(), EndRx(), and SetGenericPhyRxEndOkCallback().
|
private |
Callback - Rx start.
Definition at line 233 of file half-duplex-ideal-phy.h.
Referenced by DoDispose(), SetGenericPhyRxStartCallback(), and StartRx().
|
private |
Callback - Tx end.
Definition at line 232 of file half-duplex-ideal-phy.h.
Referenced by DoDispose(), EndTx(), and SetGenericPhyTxEndCallback().
|
private |
Trace - Rx abort.
Definition at line 228 of file half-duplex-ideal-phy.h.
Referenced by AbortRx(), and GetTypeId().
|
private |
Trace - Rx end (error)
Definition at line 230 of file half-duplex-ideal-phy.h.
Referenced by EndRx(), and GetTypeId().
|
private |
Trace - Tx end (ok)
Definition at line 229 of file half-duplex-ideal-phy.h.
Referenced by EndRx(), and GetTypeId().
|
private |
Trace - Rx start.
Definition at line 227 of file half-duplex-ideal-phy.h.
Referenced by GetTypeId(), and StartRx().
|
private |
Trace - Tx end.
Definition at line 226 of file half-duplex-ideal-phy.h.
Referenced by EndTx(), and GetTypeId().
|
private |
Trace - Tx start.
Definition at line 225 of file half-duplex-ideal-phy.h.
Referenced by GetTypeId(), and StartTx().
|
private |
Datarate.
Definition at line 222 of file half-duplex-ideal-phy.h.
Rx packet.
Definition at line 220 of file half-duplex-ideal-phy.h.
Referenced by AbortRx(), DoDispose(), EndRx(), and StartRx().
|
private |
Rx power spectral density.
Definition at line 218 of file half-duplex-ideal-phy.h.
Referenced by DoDispose(), EndRx(), and StartRx().
|
private |
PHY state.
Definition at line 223 of file half-duplex-ideal-phy.h.
Referenced by AbortRx(), ChangeState(), EndRx(), EndTx(), StartRx(), and StartTx().
Tx packet.
Definition at line 219 of file half-duplex-ideal-phy.h.
Referenced by DoDispose(), EndTx(), and StartTx().
|
private |
Tx power spectral density.
Definition at line 217 of file half-duplex-ideal-phy.h.
Referenced by DoDispose(), GetRxSpectrumModel(), SetTxPowerSpectralDensity(), and StartTx().