Virtual base for Transducer objects. More...
#include "uan-transducer.h"
Public Types | |
typedef std::list< UanPacketArrival > | ArrivalList |
List of arriving packets overlapping in time. | |
enum | State { TX , RX } |
Transducer state. More... | |
typedef std::list< Ptr< UanPhy > > | UanPhyList |
List of UanPhy objects. | |
Public Member Functions | |
virtual void | AddPhy (Ptr< UanPhy > phy)=0 |
Attach a physical network layer above this transducer. | |
virtual double | ApplyRxGainDb (double rxPowerDb, UanTxMode mode)=0 |
Apply receiver gain in dB to the received power. | |
virtual void | Clear ()=0 |
Clears all pointer references. | |
virtual const ArrivalList & | GetArrivalList () const =0 |
Get the list of overlapped (in time) packets at this transducer. | |
virtual Ptr< UanChannel > | GetChannel () const =0 |
Get the attached channel. | |
virtual const UanPhyList & | GetPhyList () const =0 |
Get the list of physical layer above this transducer. | |
virtual double | GetRxGainDb ()=0 |
Get the receiver gain added to signal at receiver in dB. | |
virtual State | GetState () const =0 |
Get the transducer state. | |
virtual bool | IsRx () const =0 |
Is the state receiving (or available for reception)? | |
virtual bool | IsTx () const =0 |
Is the state transmitting? | |
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. | |
virtual void | SetChannel (Ptr< UanChannel > chan)=0 |
Attach this transducer to a channel. | |
virtual void | SetRxGainDb (double gainDb)=0 |
Set the receiver gain. | |
virtual void | Transmit (Ptr< UanPhy > src, Ptr< Packet > packet, double txPowerDb, UanTxMode txMode)=0 |
Transmit a packet from this transducer. | |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. | |
~Object () override | |
Destructor. | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. | |
void | Dispose () |
Dispose of this Object. | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. | |
bool | IsInitialized () const |
Check if the object has been initialized. | |
void | UnidirectionalAggregateObject (Ptr< Object > other) |
Aggregate an Object to another Object. | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. | |
void | Ref () const |
Increment the reference count. | |
void | Unref () const |
Decrement the reference count. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
virtual void | DoDispose () |
Destructor implementation. | |
virtual void | DoInitialize () |
Initialize() implementation. | |
virtual void | NotifyNewAggregate () |
Notify all Objects aggregated to this one of a new Object being aggregated. | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
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.
ns3::UanTransducer is accessible through the following paths with Config::Set and Config::Connect:
No Attributes are defined for this type.
No TraceSources are defined for this type.
Group: Uan
Size of this type is 56 bytes (on a 64-bit architecture).
Definition at line 135 of file uan-transducer.h.
typedef std::list<UanPacketArrival> ns3::UanTransducer::ArrivalList |
List of arriving packets overlapping in time.
Definition at line 152 of file uan-transducer.h.
typedef std::list<Ptr<UanPhy> > ns3::UanTransducer::UanPhyList |
List of UanPhy objects.
Definition at line 154 of file uan-transducer.h.
Transducer state.
Enumerator | |
---|---|
TX | Transmitting. |
RX | Receiving. |
Definition at line 145 of file uan-transducer.h.
Attach a physical network layer above this transducer.
More than one physical layer may be attached.
phy | The physical layer. |
Implemented in ns3::UanTransducerHd.
Referenced by ns3::UanPhyGen::SetTransducer().
Apply receiver gain in dB to the received power.
rxPowerDb | Signal power in dB of arriving packet. |
mode | Mode arriving packet is using. |
Implemented in ns3::UanTransducerHd.
|
pure virtual |
Clears all pointer references.
Implemented in ns3::UanTransducerHd.
Referenced by ns3::UanNetDevice::Clear(), and ns3::UanPhyGen::Clear().
|
pure virtual |
Get the list of overlapped (in time) packets at this transducer.
Implemented in ns3::UanTransducerHd.
Referenced by ns3::UanPhyGen::CalculateSinrDb(), and ns3::UanPhyGen::GetInterferenceDb().
|
pure virtual |
|
pure virtual |
Get the list of physical layer above this transducer.
Implemented in ns3::UanTransducerHd.
|
pure virtual |
Get the receiver gain added to signal at receiver in dB.
Implemented in ns3::UanTransducerHd.
|
pure virtual |
Get the transducer state.
Implemented in ns3::UanTransducerHd.
|
static |
Register this type.
Definition at line 17 of file uan-transducer.cc.
References ns3::TypeId::SetParent().
|
pure virtual |
Is the state receiving (or available for reception)?
Implemented in ns3::UanTransducerHd.
|
pure virtual |
Is the state transmitting?
Implemented in ns3::UanTransducerHd.
|
pure virtual |
Notify this object that a new packet has arrived at this nodes location.
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.
|
pure virtual |
Attach this transducer to a channel.
chan | The channel |
Implemented in ns3::UanTransducerHd.
Referenced by ns3::UanNetDevice::SetChannel(), and ns3::UanNetDevice::SetTransducer().
|
pure virtual |
Set the receiver gain.
gainDb | Gain added at receiver, in dB. |
Implemented in ns3::UanTransducerHd.
|
pure virtual |
Transmit a packet from this transducer.
src | Source PHY. |
packet | Packet to transmit. |
txPowerDb | Outgoing Tx power of packet. |
txMode | Mode to transmit packet with. |
Implemented in ns3::UanTransducerHd.
Referenced by ns3::UanPhyGen::SendPacket().