Virtual base for Transducer objects. More...

#include "uan-transducer.h"

Inheritance diagram for ns3::UanTransducer:

Collaboration diagram for ns3::UanTransducer:

Public Types
typedef std::list< UanPacketArrival >	ArrivalList
	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...

Public Member Functions
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 ArrivalList &	GetArrivalList (void) const =0
	Get the list of overlapped (in time) packets at this transducer. More...

virtual Ptr< UanChannel >	GetChannel (void) const =0
	Get the attached channel. More...

virtual const UanPhyList &	GetPhyList (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< 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...

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[[maybe_unused]])
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= ([[maybe_unused]] 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...

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

Additional Inherited Members
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...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

Virtual base for Transducer objects.

The Transducer was added to support classes such as UanPhyDual. In a generic Phy setting, this class functions to hold information about all possibly interfering packets.

Config Paths

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

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

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

Definition at line 138 of file uan-transducer.h.

Member Typedef Documentation

◆ ArrivalList

typedef std::list<UanPacketArrival> ns3::UanTransducer::ArrivalList

List of arriving packets overlapping in time.

Definition at line 154 of file uan-transducer.h.

◆ UanPhyList

typedef std::list<Ptr<UanPhy> > ns3::UanTransducer::UanPhyList

List of UanPhy objects.

Definition at line 156 of file uan-transducer.h.

Member Enumeration Documentation

◆ State

enum ns3::UanTransducer::State

Transducer state.

Enumerator
TX	Transmitting.
RX	Receiving.

Definition at line 148 of file uan-transducer.h.

Member Function Documentation

◆ AddPhy()

virtual void ns3::UanTransducer::AddPhy ( Ptr< UanPhy > phy )

pure virtual

Attach a physical network layer above this transducer.

More than one physical layer may be attached.

Parameters

phy	The physical layer.

Implemented in ns3::UanTransducerHd.

◆ ApplyRxGainDb()

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

pure virtual

Apply receiver gain in dB to the received power.

Parameters

rxPowerDb	Signal power in dB of arriving packet.
mode	Mode arriving packet is using.

Returns: Updated receive power (in dB) with gain applied.

Implemented in ns3::UanTransducerHd.

◆ Clear()

virtual void ns3::UanTransducer::Clear ( void )

pure virtual

Clears all pointer references.

Implemented in ns3::UanTransducerHd.

◆ GetArrivalList()

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

pure virtual

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

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

Implemented in ns3::UanTransducerHd.

◆ GetChannel()

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

pure virtual

Get the attached channel.

Returns: The channel.

Implemented in ns3::UanTransducerHd.

◆ GetPhyList()

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

pure virtual

Get the list of physical layer above this transducer.

Returns: List of attached physical layers.

Implemented in ns3::UanTransducerHd.

◆ GetRxGainDb()

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

pure virtual

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

Returns: The gain (in dB).

Implemented in ns3::UanTransducerHd.

◆ GetState()

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

pure virtual

Get the transducer state.

Returns: State (TX or RX) of this transducer.

Implemented in ns3::UanTransducerHd.

◆ GetTypeId()

TypeId ns3::UanTransducer::GetTypeId ( void )

static

Register this type.

Returns: The object TypeId.

Definition at line 27 of file uan-transducer.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ IsRx()

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

pure virtual

Is the state receiving (or available for reception)?

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

Implemented in ns3::UanTransducerHd.

◆ IsTx()

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

pure virtual

Is the state transmitting?

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

Implemented in ns3::UanTransducerHd.

◆ Receive()

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

pure virtual

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

Parameters

packet	Packet arriving.
rxPowerDb	Signal power in dB of arriving packet.
txMode	Mode arriving packet is using.
pdp	PDP of arriving signal.

Implemented in ns3::UanTransducerHd.

◆ SetChannel()

virtual void ns3::UanTransducer::SetChannel ( Ptr< UanChannel > chan )

pure virtual

Attach this transducer to a channel.

Parameters

chan	The channel

Implemented in ns3::UanTransducerHd.

◆ SetRxGainDb()

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

pure virtual

Set the receiver gain.

Parameters

gainDb Gain added at receiver, in dB.

Implemented in ns3::UanTransducerHd.

◆ Transmit()

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

pure virtual

Transmit a packet from this transducer.

Parameters

src	Source PHY.
packet	Packet to transmit.
txPowerDb	Outgoing Tx power of packet.
txMode	Mode to transmit packet with.

Implemented in ns3::UanTransducerHd.

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

src/uan/model/uan-transducer.h
src/uan/model/uan-transducer.cc

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Config Paths

Member Typedef Documentation

◆ ArrivalList

◆ UanPhyList

Member Enumeration Documentation

◆ State

Member Function Documentation

◆ AddPhy()

◆ ApplyRxGainDb()

◆ Clear()

◆ GetArrivalList()

◆ GetChannel()

◆ GetPhyList()

◆ GetRxGainDb()

◆ GetState()

◆ GetTypeId()

◆ IsRx()

◆ IsTx()

◆ Receive()

◆ SetChannel()

◆ SetRxGainDb()

◆ Transmit()