Channel class used by UAN devices. More...
#include "uan-channel.h"
Public Types | |
typedef std::vector< std::pair< Ptr< UanNetDevice >, Ptr< UanTransducer > > > | UanDeviceList |
UanDeviceList is a standard template vector of pairs (UanNetDevice, UanTransducer) | |
Public Member Functions | |
UanChannel () | |
Constructor. | |
~UanChannel () override | |
Dummy destructor, see DoDispose. | |
void | AddDevice (Ptr< UanNetDevice > dev, Ptr< UanTransducer > trans) |
Adds device to receiver list for this channel. | |
void | Clear () |
Clear all pointer references. | |
Ptr< NetDevice > | GetDevice (std::size_t i) const override |
std::size_t | GetNDevices () const override |
double | GetNoiseDbHz (double fKhz) |
Get the noise level on the channel. | |
void | SetNoiseModel (Ptr< UanNoiseModel > noise) |
Set the noise model this channel will use to determine ambient channel noise. | |
void | SetPropagationModel (Ptr< UanPropModel > prop) |
Set the propagation model this channel will use for path loss/propagation delay. | |
virtual void | TxPacket (Ptr< UanTransducer > src, Ptr< Packet > packet, double txPowerDb, UanTxMode txmode) |
Send a packet out on the channel. | |
Public Member Functions inherited from ns3::Channel | |
Channel () | |
~Channel () override | |
uint32_t | GetId () const |
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::Channel | |
static TypeId | GetTypeId () |
Get the type ID. | |
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. | |
Protected Member Functions | |
void | DoDispose () override |
Destructor implementation. | |
void | SendUp (uint32_t i, Ptr< Packet > packet, double rxPowerDb, UanTxMode txMode, UanPdp pdp) |
Send a packet up to the receiving UanTransducer. | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
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. | |
Protected Attributes | |
bool | m_cleared |
Has Clear ever been called on the channel. | |
UanDeviceList | m_devList |
The list of devices on this channel. | |
Ptr< UanNoiseModel > | m_noise |
The noise model. | |
Ptr< UanPropModel > | m_prop |
The propagation model. | |
Additional Inherited Members | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Channel class used by UAN devices.
Definition at line 35 of file uan-channel.h.
typedef std::vector<std::pair<Ptr<UanNetDevice>, Ptr<UanTransducer> > > ns3::UanChannel::UanDeviceList |
UanDeviceList is a standard template vector of pairs (UanNetDevice, UanTransducer)
Definition at line 42 of file uan-channel.h.
ns3::UanChannel::UanChannel | ( | ) |
Constructor.
Definition at line 57 of file uan-channel.cc.
|
override |
Dummy destructor, see DoDispose.
Definition at line 64 of file uan-channel.cc.
void ns3::UanChannel::AddDevice | ( | Ptr< UanNetDevice > | dev, |
Ptr< UanTransducer > | trans ) |
Adds device to receiver list for this channel.
dev | Net Device of node. |
trans | Transducer of net device attached to this channel. |
Definition at line 130 of file uan-channel.cc.
References m_devList, and NS_LOG_DEBUG.
void ns3::UanChannel::Clear | ( | ) |
Clear all pointer references.
Definition at line 69 of file uan-channel.cc.
References m_cleared, m_devList, m_noise, and m_prop.
Referenced by DoDispose().
|
overrideprotectedvirtual |
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 104 of file uan-channel.cc.
References Clear(), and ns3::Object::DoDispose().
i | index of NetDevice to retrieve |
This method must be implemented by subclasses.
Implements ns3::Channel.
Definition at line 124 of file uan-channel.cc.
References m_devList.
|
overridevirtual |
This method must be implemented by subclasses.
Implements ns3::Channel.
Definition at line 118 of file uan-channel.cc.
References m_devList.
Get the noise level on the channel.
fKhz | Frequency in kHz. |
Definition at line 199 of file uan-channel.cc.
|
static |
Register this type.
Definition at line 37 of file uan-channel.cc.
References m_noise, m_prop, ns3::MakePointerAccessor(), ns3::MakePointerChecker(), and ns3::TypeId::SetParent().
|
protected |
Send a packet up to the receiving UanTransducer.
i | Device number. |
packet | The received packet. |
rxPowerDb | Signal power in dB of arriving packet. |
txMode | Mode arriving packet is using. |
pdp | PDP of arriving signal. |
Definition at line 192 of file uan-channel.cc.
References m_devList, and NS_LOG_DEBUG.
Referenced by TxPacket().
void ns3::UanChannel::SetNoiseModel | ( | Ptr< UanNoiseModel > | noise | ) |
Set the noise model this channel will use to determine ambient channel noise.
noise | The noise model. |
Definition at line 185 of file uan-channel.cc.
void ns3::UanChannel::SetPropagationModel | ( | Ptr< UanPropModel > | prop | ) |
Set the propagation model this channel will use for path loss/propagation delay.
prop | The propagation model. |
Definition at line 111 of file uan-channel.cc.
References m_prop, and NS_LOG_DEBUG.
|
virtual |
Send a packet out on the channel.
src | Transducer transmitting packet. |
packet | Packet to be transmitted. |
txPowerDb | Transmission power in dB. |
txmode | UanTxMode defining modulation of transmitted packet. |
Definition at line 137 of file uan-channel.cc.
References m_devList, m_prop, NS_ASSERT, NS_LOG_DEBUG, ns3::Simulator::ScheduleWithContext(), and SendUp().
|
protected |
Has Clear ever been called on the channel.
Definition at line 111 of file uan-channel.h.
Referenced by Clear().
|
protected |
The list of devices on this channel.
Definition at line 107 of file uan-channel.h.
Referenced by AddDevice(), Clear(), GetDevice(), GetNDevices(), SendUp(), and TxPacket().
|
protected |
The noise model.
Definition at line 109 of file uan-channel.h.
Referenced by Clear(), GetNoiseDbHz(), GetTypeId(), and SetNoiseModel().
|
protected |
The propagation model.
Definition at line 108 of file uan-channel.h.
Referenced by Clear(), GetTypeId(), SetPropagationModel(), and TxPacket().