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 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 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 | 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 |
| Implement the GetInstanceTypeId method defined in ObjectBase. More... | |
| template<typename T > | |
| Ptr< T > | GetObject (void) const |
| Get a pointer to the requested aggregated Object. More... | |
| template<typename T > | |
| Ptr< T > | GetObject (TypeId tid) const |
| Get a pointer to the requested aggregated Object. More... | |
| void | Initialize (void) |
| Invoke DoInitialize on all Objects aggregated to this one. More... | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
| SimpleRefCount () | |
| Constructor. More... | |
| SimpleRefCount (const SimpleRefCount &o) | |
| Copy constructor. More... | |
| uint32_t | GetReferenceCount (void) const |
| Get the reference count of the object. More... | |
| SimpleRefCount & | operator= (const SimpleRefCount &o) |
| Assignment. 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::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
| static void | Cleanup (void) |
| Noop. 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... | |
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.
Size of this type is 32 bytes (on a 64-bit architecture).
Definition at line 138 of file uan-transducer.h.
List of arriving packets overlapping in time.
Definition at line 154 of file uan-transducer.h.
| typedef std::list<Ptr<UanPhy> > ns3::UanTransducer::UanPhyList |
List of UanPhy objects.
Definition at line 156 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.
|
pure virtual |
Clears all pointer references.
Implemented in ns3::UanTransducerHd.
|
pure virtual |
Get the list of overlapped (in time) packets at this transducer.
Implemented in ns3::UanTransducerHd.
|
pure virtual |
|
pure virtual |
Get the list of physical layer above this transducer.
Implemented in ns3::UanTransducerHd.
|
pure virtual |
Get the transducer state.
Implemented in ns3::UanTransducerHd.
|
static |
Register this type.
Definition at line 27 of file uan-transducer.cc.
References ns3::TypeId::SetParent().
Here is the call graph for this function:
|
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.
|
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.