A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
ns3::HalfDuplexIdealPhy Class Reference
Spectrum Models

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

+ Inheritance diagram for ns3::HalfDuplexIdealPhy:

Public Types

enum  State { IDLE, TX, RX }
 

Public Member Functions

Ptr< NetDevice > GetDevice ()
 
Ptr< MobilityModel > GetMobility ()
 
DataRate GetRate () const
 
Ptr< AntennaModel > GetRxAntenna ()
 
Ptr< const SpectrumModel > GetRxSpectrumModel () const
 
void SetAntenna (Ptr< AntennaModel > a)
 
void SetChannel (Ptr< SpectrumChannel > c)
 
void SetDevice (Ptr< NetDevice > d)
 
void SetGenericPhyRxEndErrorCallback (GenericPhyRxEndErrorCallback c)
 
void SetGenericPhyRxEndOkCallback (GenericPhyRxEndOkCallback c)
 
void SetGenericPhyRxStartCallback (GenericPhyRxStartCallback c)
 
void SetGenericPhyTxEndCallback (GenericPhyTxEndCallback c)
 
void SetMobility (Ptr< MobilityModel > m)
 
void SetNoisePowerSpectralDensity (Ptr< const SpectrumValue > noisePsd)
 
void SetRate (DataRate rate)
 
void SetTxPowerSpectralDensity (Ptr< SpectrumValue > txPsd)
 
void StartRx (Ptr< SpectrumSignalParameters > params)
 
bool StartTx (Ptr< Packet > p)
 
- Public Member Functions inherited from ns3::Object
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 
AggregateIterator GetAggregateIterator (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
 
uint32_t GetReferenceCount (void) const
 
SimpleRefCount & operator= (const SimpleRefCount &o)
 
void Ref (void) const
 
void Unref (void) const
 
- Public Member Functions inherited from ns3::ObjectBase
void GetAttribute (std::string name, AttributeValue &value) const
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Static Public Member Functions

static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::SpectrumPhy
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Private Member Functions

void AbortRx ()
 
void ChangeState (State newState)
 
virtual void DoDispose (void)
 
void EndRx ()
 
void EndTx ()
 

Private Attributes

Ptr< AntennaModel > m_antenna
 
Ptr< SpectrumChannel > m_channel
 
EventId m_endRxEventId
 
SpectrumInterference m_interference
 
Ptr< MobilityModel > m_mobility
 
Ptr< NetDevice > m_netDevice
 
GenericPhyRxEndErrorCallback m_phyMacRxEndErrorCallback
 
GenericPhyRxEndOkCallback m_phyMacRxEndOkCallback
 
GenericPhyRxStartCallback m_phyMacRxStartCallback
 
GenericPhyTxEndCallback m_phyMacTxEndCallback
 
TracedCallback< Ptr< const
Packet > > 		m_phyRxAbortTrace
 
TracedCallback< Ptr< const
Packet > > 		m_phyRxEndErrorTrace
 
TracedCallback< Ptr< const
Packet > > 		m_phyRxEndOkTrace
 
TracedCallback< Ptr< const
Packet > > 		m_phyRxStartTrace
 
TracedCallback< Ptr< const
Packet > > 		m_phyTxEndTrace
 
TracedCallback< Ptr< const
Packet > > 		m_phyTxStartTrace
 
DataRate m_rate
 
Ptr< Packet > m_rxPacket
 
Ptr< const SpectrumValue > m_rxPsd
 
State m_state
 
Ptr< Packet > m_txPacket
 
Ptr< SpectrumValue > m_txPsd
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoInitialize (void)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

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

This PHY model supports a single antenna model instance which is used for both transmission and reception.

Doxygen introspection did not find any typical Config paths.

Attributes

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

TraceSources

  • 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)

Definition at line 78 of file half-duplex-ideal-phy.h.

Member Enumeration Documentation

enum ns3::HalfDuplexIdealPhy::State

PHY states

Definition at line 89 of file half-duplex-ideal-phy.h.

Member Function Documentation

void ns3::HalfDuplexIdealPhy::DoDispose ( void  )
privatevirtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden 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(), and NS_LOG_FUNCTION.

Ptr< NetDevice > ns3::HalfDuplexIdealPhy::GetDevice ( )
virtual

get the associated NetDevice instance

Returns
a Ptr to the associated NetDevice instance

Implements ns3::SpectrumPhy.

Definition at line 132 of file half-duplex-ideal-phy.cc.

References NS_LOG_FUNCTION.

Ptr< MobilityModel > ns3::HalfDuplexIdealPhy::GetMobility ( )
virtual

get the associated MobilityModel instance

Returns
a Ptr to the associated MobilityModel instance

Implements ns3::SpectrumPhy.

Definition at line 140 of file half-duplex-ideal-phy.cc.

References NS_LOG_FUNCTION.

DataRate ns3::HalfDuplexIdealPhy::GetRate ( void  ) const
Returns
the PHY rate used by this PHY.

Definition at line 208 of file half-duplex-ideal-phy.cc.

References NS_LOG_FUNCTION.

Ptr< AntennaModel > ns3::HalfDuplexIdealPhy::GetRxAntenna ( )
virtual

get the AntennaModel used by the NetDevice for reception

Returns
a Ptr to the AntennaModel used by the NetDevice for reception

Implements ns3::SpectrumPhy.

Definition at line 246 of file half-duplex-ideal-phy.cc.

References NS_LOG_FUNCTION.

Ptr< const SpectrumModel > ns3::HalfDuplexIdealPhy::GetRxSpectrumModel ( ) const
virtual
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.

Definition at line 171 of file half-duplex-ideal-phy.cc.

void ns3::HalfDuplexIdealPhy::SetAntenna ( Ptr< AntennaModel >  a)

set the AntennaModel to be used

Parameters
athe Antenna Model

Definition at line 253 of file half-duplex-ideal-phy.cc.

References NS_LOG_FUNCTION.

void ns3::HalfDuplexIdealPhy::SetChannel ( Ptr< SpectrumChannel >  c)
virtual

Set the channel attached to this device.

Parameters
cthe channel

Implements ns3::SpectrumPhy.

Definition at line 164 of file half-duplex-ideal-phy.cc.

References NS_LOG_FUNCTION.

void ns3::HalfDuplexIdealPhy::SetDevice ( Ptr< NetDevice >  d)
virtual

set the associated NetDevice instance

Parameters
dthe NetDevice instance

Implements ns3::SpectrumPhy.

Definition at line 148 of file half-duplex-ideal-phy.cc.

References 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 betweenthe PHY and the MAC

Parameters
cthe callback

Definition at line 231 of file half-duplex-ideal-phy.cc.

References NS_LOG_FUNCTION.

void ns3::HalfDuplexIdealPhy::SetGenericPhyRxEndOkCallback ( GenericPhyRxEndOkCallback  c)

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

Parameters
cthe callback

Definition at line 239 of file half-duplex-ideal-phy.cc.

References NS_LOG_FUNCTION.

void ns3::HalfDuplexIdealPhy::SetGenericPhyRxStartCallback ( GenericPhyRxStartCallback  c)

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

Parameters
cthe callback

Definition at line 223 of file half-duplex-ideal-phy.cc.

References NS_LOG_FUNCTION.

void ns3::HalfDuplexIdealPhy::SetGenericPhyTxEndCallback ( GenericPhyTxEndCallback  c)

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

Parameters
cthe callback

Definition at line 216 of file half-duplex-ideal-phy.cc.

References NS_LOG_FUNCTION.

void ns3::HalfDuplexIdealPhy::SetMobility ( Ptr< MobilityModel >  m)
virtual

Set the mobility model associated with this device.

Parameters
mthe mobility model

Implements ns3::SpectrumPhy.

Definition at line 156 of file half-duplex-ideal-phy.cc.

References NS_LOG_FUNCTION.

void ns3::HalfDuplexIdealPhy::SetNoisePowerSpectralDensity ( Ptr< const SpectrumValue >  noisePsd)
Parameters
noisePsdthe Noise Power Spectral Density in power units (Watt, Pascal...) per Hz.

Definition at line 193 of file half-duplex-ideal-phy.cc.

References 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.

Parameters
rate

Definition at line 201 of file half-duplex-ideal-phy.cc.

References NS_LOG_FUNCTION.

void ns3::HalfDuplexIdealPhy::SetTxPowerSpectralDensity ( Ptr< SpectrumValue >  txPsd)

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

Parameters
txPsd

Definition at line 184 of file half-duplex-ideal-phy.cc.

References NS_ASSERT, NS_LOG_FUNCTION, and NS_LOG_INFO.

void ns3::HalfDuplexIdealPhy::StartRx ( Ptr< SpectrumSignalParameters >  params)
virtual

Notify the SpectrumPhy instance of an incoming signal

Parameters
paramsthe parameters of the signals being received

Implements ns3::SpectrumPhy.

Definition at line 328 of file half-duplex-ideal-phy.cc.

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

bool ns3::HalfDuplexIdealPhy::StartTx ( Ptr< Packet >  p)

Start a transmission

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

Definition at line 267 of file half-duplex-ideal-phy.cc.

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

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

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