A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ns3::UanTransducer Class Referenceabstract

Virtual base for Transducer objects. More...

#include <introspected-doxygen.h>

+ Inheritance diagram for ns3::UanTransducer:

Public Types

typedef std::list
< UanPacketArrival
ArrivalList
 Arrival list is a standard template library list of UanPacketArrivals objects.
 
enum  State { TX, RX }
 Transducer state (receiving or transmitting)
 
typedef std::list< Ptr< UanPhy > > UanPhyList
 UanPhyList is a standard template library list of UanPhy objects.
 

Public Member Functions

virtual void AddPhy (Ptr< UanPhy > phy)=0
 
virtual void Clear (void)=0
 
virtual const ArrivalListGetArrivalList (void) const =0
 
virtual Ptr< UanChannelGetChannel (void) const =0
 
virtual const UanPhyListGetPhyList (void) const =0
 
virtual State GetState (void) const =0
 
virtual bool IsRx (void) const =0
 
virtual bool IsTx (void) const =0
 
virtual void Receive (Ptr< Packet > packet, double rxPowerDb, UanTxMode txMode, UanPdp pdp)=0
 Receive Notify this object that a new packet has arrived at this nodes location. More...
 
virtual void SetChannel (Ptr< UanChannel > chan)=0
 
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
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
 
SimpleRefCountoperator= (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::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)
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoDispose (void)
 
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

Virtual base for Transducer objects.

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.

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.

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

Member Function Documentation

virtual void ns3::UanTransducer::AddPhy ( Ptr< UanPhy phy)
pure virtual
Parameters
phyAdd phy above this transducer (may connect > 1 Phy to a transducer)

Implemented in ns3::UanTransducerHd.

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

Clears all pointer references

Implemented in ns3::UanTransducerHd.

virtual const ArrivalList& ns3::UanTransducer::GetArrivalList ( void  ) const
pure virtual
Returns
List of all packets currently crossing this node in the water.

Implemented in ns3::UanTransducerHd.

virtual Ptr<UanChannel> ns3::UanTransducer::GetChannel ( void  ) const
pure virtual
Returns
Channel this transducer is attached to

Implemented in ns3::UanTransducerHd.

virtual const UanPhyList& ns3::UanTransducer::GetPhyList ( void  ) const
pure virtual
Returns
List of all Phy's this transducer sends packets to.

Implemented in ns3::UanTransducerHd.

virtual State ns3::UanTransducer::GetState ( void  ) const
pure virtual
Returns
State (TX or RX) of this transducer

Implemented in ns3::UanTransducerHd.

virtual bool ns3::UanTransducer::IsRx ( void  ) const
pure virtual
Returns
True if this transducer is available for receiving an incoming packet.

Implemented in ns3::UanTransducerHd.

virtual bool ns3::UanTransducer::IsTx ( void  ) const
pure virtual
Returns
True if there is a packet being transmitted from this transducer.

Implemented in ns3::UanTransducerHd.

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

Receive 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

Implemented in ns3::UanTransducerHd.

virtual void ns3::UanTransducer::SetChannel ( Ptr< UanChannel chan)
pure virtual
Parameters
chanChannel this transducer is attached to

Implemented in ns3::UanTransducerHd.

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

Transmit a packet from this transducer.

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

Implemented in ns3::UanTransducerHd.


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