A Discrete-Event Network Simulator
API
ns3::UanTransducerHd Class Reference

Half duplex implementation of transducer object. More...

#include "uan-transducer-hd.h"

+ Inheritance diagram for ns3::UanTransducerHd:
+ Collaboration diagram for ns3::UanTransducerHd:

Public Member Functions

 UanTransducerHd ()
 Constructor. More...
 
virtual ~UanTransducerHd ()
 Dummy destructor, see DoDispose. More...
 
virtual void AddPhy (Ptr< UanPhy >)
 Attach a physical network layer above this transducer. More...
 
virtual double ApplyRxGainDb (double rxPowerDb, UanTxMode mode)
 Apply receiver gain in dB to the received power. More...
 
virtual void Clear (void)
 Clears all pointer references. More...
 
virtual const ArrivalListGetArrivalList (void) const
 Get the list of overlapped (in time) packets at this transducer. More...
 
virtual Ptr< UanChannelGetChannel (void) const
 Get the attached channel. More...
 
virtual const UanPhyListGetPhyList (void) const
 Get the list of physical layer above this transducer. More...
 
virtual double GetRxGainDb (void)
 Get the receiver gain added to signal at receiver in dB. More...
 
virtual State GetState (void) const
 Get the transducer state. More...
 
virtual bool IsRx (void) const
 Is the state receiving (or available for reception)? More...
 
virtual bool IsTx (void) const
 Is the state transmitting? More...
 
virtual void Receive (Ptr< Packet > packet, double rxPowerDb, UanTxMode txMode, UanPdp pdp)
 Notify this object that a new packet has arrived at this nodes location. More...
 
virtual void SetChannel (Ptr< UanChannel > chan)
 Attach this transducer to a channel. More...
 
virtual void SetRxGainDb (double gainDb)
 Set the receiver gain. More...
 
virtual void Transmit (Ptr< UanPhy > src, Ptr< Packet > packet, double txPowerDb, UanTxMode txMode)
 Transmit a packet from this transducer. More...
 
virtual void AddPhy (Ptr< UanPhy > phy)=0
 Attach a physical network layer above this transducer. More...
 
virtual double ApplyRxGainDb (double rxPowerDb, UanTxMode mode)=0
 Apply receiver gain in dB to the received power. More...
 
virtual void Clear (void)=0
 Clears all pointer references. More...
 
virtual const ArrivalListGetArrivalList (void) const =0
 Get the list of overlapped (in time) packets at this transducer. More...
 
virtual Ptr< UanChannelGetChannel (void) const =0
 Get the attached channel. More...
 
virtual const UanPhyListGetPhyList (void) const =0
 Get the list of physical layer above this transducer. More...
 
virtual double GetRxGainDb (void)=0
 Get the receiver gain added to signal at receiver in dB. More...
 
virtual State GetState (void) const =0
 Get the transducer state. More...
 
virtual bool IsRx (void) const =0
 Is the state receiving (or available for reception)? More...
 
virtual bool IsTx (void) const =0
 Is the state transmitting? More...
 
virtual void Receive (Ptr< Packet > packet, double rxPowerDb, UanTxMode txMode, UanPdp pdp)=0
 Notify this object that a new packet has arrived at this nodes location. More...
 
virtual void SetChannel (Ptr< UanChannel > chan)=0
 Attach this transducer to a channel. More...
 
virtual void SetRxGainDb (double gainDb)=0
 Set the receiver gain. More...
 
virtual void Transmit (Ptr< UanPhy > src, Ptr< Packet > packet, double txPowerDb, UanTxMode txMode)=0
 Transmit a packet from this transducer. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<>
Ptr< ObjectGetObject () 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< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) 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)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) 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 erros. More...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. 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 (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::UanTransducer
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Protected Member Functions

virtual void DoDispose ()
 Destructor implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 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 (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Private Member Functions

void EndTx (void)
 Handle end of transmission event. More...
 
void RemoveArrival (UanPacketArrival arrival)
 Remove an entry from the arrival list. More...
 

Private Attributes

ArrivalList m_arrivalList
 List of arriving packets which overlap in time. More...
 
Ptr< UanChannelm_channel
 The attached channel. More...
 
bool m_cleared
 Flab when we've been cleared. More...
 
EventId m_endTxEvent
 Event scheduled for end of transmission. More...
 
Time m_endTxTime
 Time at which transmission will be completed. More...
 
UanPhyList m_phyList
 List of physical layers attached above this tranducer. More...
 
double m_rxGainDb
 Receive gain in dB. More...
 
State m_state
 Transducer state. More...
 

Additional Inherited Members

- Public Types inherited from ns3::UanTransducer
typedef std::list< UanPacketArrivalArrivalList
 List of arriving packets overlapping in time. More...
 
enum  State { TX , RX }
 Transducer state. More...
 
typedef std::list< Ptr< UanPhy > > UanPhyList
 List of UanPhy objects. More...
 

Detailed Description

Half duplex implementation of transducer object.

This class will only allow attached Phy's to receive packets if not in TX mode.

Config Paths

ns3::UanTransducerHd is accessible through the following paths with Config::Set and Config::Connect:

  • "/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Transducer/$ns3::UanTransducerHd"

Attributes

  • RxGainDb: Gain in Db added to incoming signal at receiver.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0
    • Flags: construct write read

No TraceSources are defined for this type.
Size of this type is 120 bytes (on a 64-bit architecture).

Definition at line 36 of file uan-transducer-hd.h.

Constructor & Destructor Documentation

◆ UanTransducerHd()

ns3::UanTransducerHd::UanTransducerHd ( )

Constructor.

Definition at line 36 of file uan-transducer-hd.cc.

◆ ~UanTransducerHd()

ns3::UanTransducerHd::~UanTransducerHd ( )
virtual

Dummy destructor, see DoDispose.

Definition at line 45 of file uan-transducer-hd.cc.

Member Function Documentation

◆ AddPhy()

void ns3::UanTransducerHd::AddPhy ( Ptr< UanPhy phy)
virtual

Attach a physical network layer above this transducer.

More than one physical layer may be attached.

Parameters
phyThe physical layer.

Implements ns3::UanTransducer.

Definition at line 244 of file uan-transducer-hd.cc.

References m_phyList, and third::phy.

◆ ApplyRxGainDb()

double ns3::UanTransducerHd::ApplyRxGainDb ( double  rxPowerDb,
UanTxMode  mode 
)
virtual

Apply receiver gain in dB to the received power.

Parameters
rxPowerDbSignal power in dB of arriving packet.
modeMode arriving packet is using.
Returns
Updated receive power (in dB) with gain applied.

Implements ns3::UanTransducer.

Definition at line 143 of file uan-transducer-hd.cc.

References GetRxGainDb(), NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by Receive().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ Clear()

void ns3::UanTransducerHd::Clear ( void  )
virtual

Clears all pointer references.

Implements ns3::UanTransducer.

Definition at line 50 of file uan-transducer-hd.cc.

References ns3::EventId::Cancel(), m_arrivalList, m_channel, m_cleared, m_endTxEvent, and m_phyList.

Referenced by DoDispose().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ DoDispose()

void ns3::UanTransducerHd::DoDispose ( void  )
protectedvirtual

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 83 of file uan-transducer-hd.cc.

References Clear(), and ns3::Object::DoDispose().

+ Here is the call graph for this function:

◆ EndTx()

void ns3::UanTransducerHd::EndTx ( void  )
private

Handle end of transmission event.

Definition at line 225 of file uan-transducer-hd.cc.

References m_endTxTime, m_state, NS_ASSERT, ns3::UanTransducer::RX, ns3::Seconds(), and ns3::UanTransducer::TX.

Referenced by Transmit().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetArrivalList()

const UanTransducer::ArrivalList & ns3::UanTransducerHd::GetArrivalList ( void  ) const
virtual

Get the list of overlapped (in time) packets at this transducer.

Returns
List of all packets currently crossing this node in the water.

Implements ns3::UanTransducer.

Definition at line 125 of file uan-transducer-hd.cc.

References m_arrivalList.

◆ GetChannel()

Ptr< UanChannel > ns3::UanTransducerHd::GetChannel ( void  ) const
virtual

Get the attached channel.

Returns
The channel.

Implements ns3::UanTransducer.

Definition at line 239 of file uan-transducer-hd.cc.

References m_channel.

◆ GetPhyList()

const UanTransducer::UanPhyList & ns3::UanTransducerHd::GetPhyList ( void  ) const
virtual

Get the list of physical layer above this transducer.

Returns
List of attached physical layers.

Implements ns3::UanTransducer.

Definition at line 250 of file uan-transducer-hd.cc.

References m_phyList.

◆ GetRxGainDb()

double ns3::UanTransducerHd::GetRxGainDb ( void  )
virtual

Get the receiver gain added to signal at receiver in dB.

Returns
The gain (in dB).

Implements ns3::UanTransducer.

Definition at line 137 of file uan-transducer-hd.cc.

References m_rxGainDb.

Referenced by ApplyRxGainDb().

+ Here is the caller graph for this function:

◆ GetState()

UanTransducer::State ns3::UanTransducerHd::GetState ( void  ) const
virtual

Get the transducer state.

Returns
State (TX or RX) of this transducer.

Implements ns3::UanTransducer.

Definition at line 105 of file uan-transducer-hd.cc.

References m_state.

◆ GetTypeId()

TypeId ns3::UanTransducerHd::GetTypeId ( void  )
static

Register this type.

Returns
The object TypeId.

Definition at line 89 of file uan-transducer-hd.cc.

References m_rxGainDb, ns3::MakeDoubleAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ IsRx()

bool ns3::UanTransducerHd::IsRx ( void  ) const
virtual

Is the state receiving (or available for reception)?

Returns
True if this transducer is available for receiving an incoming packet.

Implements ns3::UanTransducer.

Definition at line 112 of file uan-transducer-hd.cc.

References m_state, and ns3::UanTransducer::RX.

◆ IsTx()

bool ns3::UanTransducerHd::IsTx ( void  ) const
virtual

Is the state transmitting?

Returns
True if there is a packet being transmitted from this transducer.

Implements ns3::UanTransducer.

Definition at line 118 of file uan-transducer-hd.cc.

References m_state, and ns3::UanTransducer::TX.

◆ Receive()

void ns3::UanTransducerHd::Receive ( Ptr< Packet packet,
double  rxPowerDb,
UanTxMode  txMode,
UanPdp  pdp 
)
virtual

Notify this object that a new packet has arrived at this nodes location.

Parameters
packetPacket arriving.
rxPowerDbSignal power in dB of arriving packet.
txModeMode arriving packet is using.
pdpPDP of arriving signal.

Implements ns3::UanTransducer.

Definition at line 152 of file uan-transducer-hd.cc.

References ApplyRxGainDb(), ns3::UanTxMode::GetDataRateBps(), ns3::Packet::GetSize(), m_arrivalList, m_phyList, m_state, ns3::Now(), ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, RemoveArrival(), ns3::UanTransducer::RX, ns3::Time::S, ns3::Simulator::Schedule(), and ns3::Seconds().

+ Here is the call graph for this function:

◆ RemoveArrival()

void ns3::UanTransducerHd::RemoveArrival ( UanPacketArrival  arrival)
private

Remove an entry from the arrival list.

Parameters
arrivalThe packet arrival to remove.

Definition at line 256 of file uan-transducer-hd.cc.

References ns3::UanPacketArrival::GetPacket(), m_arrivalList, and m_phyList.

Referenced by Receive().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetChannel()

void ns3::UanTransducerHd::SetChannel ( Ptr< UanChannel chan)
virtual

Attach this transducer to a channel.

Parameters
chanThe channel

Implements ns3::UanTransducer.

Definition at line 232 of file uan-transducer-hd.cc.

References m_channel, and NS_LOG_DEBUG.

◆ SetRxGainDb()

void ns3::UanTransducerHd::SetRxGainDb ( double  gainDb)
virtual

Set the receiver gain.

Parameters
gainDbGain added at receiver, in dB.

Implements ns3::UanTransducer.

Definition at line 131 of file uan-transducer-hd.cc.

References m_rxGainDb.

◆ Transmit()

void ns3::UanTransducerHd::Transmit ( Ptr< UanPhy src,
Ptr< Packet packet,
double  txPowerDb,
UanTxMode  txMode 
)
virtual

Transmit a packet from this transducer.

Parameters
srcSource PHY.
packetPacket to transmit.
txPowerDbOutgoing Tx power of packet.
txModeMode to transmit packet with.

Implements ns3::UanTransducer.

Definition at line 184 of file uan-transducer-hd.cc.

References ns3::EventId::Cancel(), EndTx(), ns3::UanTxMode::GetDataRateBps(), ns3::Packet::GetSize(), m_channel, m_endTxEvent, m_endTxTime, m_phyList, m_state, max, ns3::UanPhy::NotifyTxEnd(), ns3::Simulator::Now(), NS_LOG_DEBUG, ns3::Simulator::Schedule(), ns3::Seconds(), and ns3::UanTransducer::TX.

+ Here is the call graph for this function:

Member Data Documentation

◆ m_arrivalList

ArrivalList ns3::UanTransducerHd::m_arrivalList
private

List of arriving packets which overlap in time.

Definition at line 68 of file uan-transducer-hd.h.

Referenced by Clear(), GetArrivalList(), Receive(), and RemoveArrival().

◆ m_channel

Ptr<UanChannel> ns3::UanTransducerHd::m_channel
private

The attached channel.

Definition at line 70 of file uan-transducer-hd.h.

Referenced by Clear(), GetChannel(), SetChannel(), and Transmit().

◆ m_cleared

bool ns3::UanTransducerHd::m_cleared
private

Flab when we've been cleared.

Definition at line 73 of file uan-transducer-hd.h.

Referenced by Clear().

◆ m_endTxEvent

EventId ns3::UanTransducerHd::m_endTxEvent
private

Event scheduled for end of transmission.

Definition at line 71 of file uan-transducer-hd.h.

Referenced by Clear(), and Transmit().

◆ m_endTxTime

Time ns3::UanTransducerHd::m_endTxTime
private

Time at which transmission will be completed.

Definition at line 72 of file uan-transducer-hd.h.

Referenced by EndTx(), and Transmit().

◆ m_phyList

UanPhyList ns3::UanTransducerHd::m_phyList
private

List of physical layers attached above this tranducer.

Definition at line 69 of file uan-transducer-hd.h.

Referenced by AddPhy(), Clear(), GetPhyList(), Receive(), RemoveArrival(), and Transmit().

◆ m_rxGainDb

double ns3::UanTransducerHd::m_rxGainDb
private

Receive gain in dB.

Definition at line 74 of file uan-transducer-hd.h.

Referenced by GetRxGainDb(), GetTypeId(), and SetRxGainDb().

◆ m_state

State ns3::UanTransducerHd::m_state
private

Transducer state.

Definition at line 67 of file uan-transducer-hd.h.

Referenced by EndTx(), GetState(), IsRx(), IsTx(), Receive(), and Transmit().


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