A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::UanChannel Class Reference

Channel class used by UAN devices. More...

#include "uan-channel.h"

+ Inheritance diagram for ns3::UanChannel:
+ Collaboration diagram for ns3::UanChannel:

Public Types

typedef std::vector< std::pair
< Ptr< UanNetDevice >, Ptr
< UanTransducer > > > 
UanDeviceList
 UanDeviceList is a standard template vector of pairs (UanNetDevice, UanTransducer) More...
 

Public Member Functions

 UanChannel ()
 Constructor. More...
 
virtual ~UanChannel ()
 Dummy destructor, see DoDispose. More...
 
void AddDevice (Ptr< UanNetDevice > dev, Ptr< UanTransducer > trans)
 Adds device to receiver list for this channel. More...
 
void Clear (void)
 Clear all pointer references. More...
 
virtual Ptr< NetDeviceGetDevice (uint32_t i) const
 
virtual uint32_t GetNDevices (void) const
 
double GetNoiseDbHz (double fKhz)
 Get the noise level on the channel. More...
 
void SetNoiseModel (Ptr< UanNoiseModel > noise)
 Set the noise model this channel will use to determine ambient channel noise. More...
 
void SetPropagationModel (Ptr< UanPropModel > prop)
 Set the propagation model this channel will use for path loss/propagation delay. More...
 
void TxPacket (Ptr< UanTransducer > src, Ptr< Packet > packet, double txPowerDb, UanTxMode txmode)
 Send a packet out on the channel. More...
 
- Public Member Functions inherited from ns3::Channel
 Channel ()
 
virtual ~Channel ()
 
uint32_t GetId (void) const
 
- 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 by TypeId. 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...
 
SimpleRefCountoperator= (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::Channel
static TypeId GetTypeId (void)
 Get the type ID. 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...
 

Protected Member Functions

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

Private Member Functions

void SendUp (uint32_t i, Ptr< Packet > packet, double rxPowerDb, UanTxMode txMode, UanPdp pdp)
 Send a packet up to the receiving UanTransducer. More...
 

Private Attributes

bool m_cleared
 Has Clear ever been called on the channel. More...
 
UanDeviceList m_devList
 The list of devices on this channel. More...
 
Ptr< UanNoiseModelm_noise
 The noise model. More...
 
Ptr< UanPropModelm_prop
 The propagation model. More...
 

Additional Inherited Members

Detailed Description

Channel class used by UAN devices.

Config Paths

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

  • "/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel"
  • "/ChannelList/[i]/$ns3::UanChannel"

Attributes

Attributes defined in parent class ns3::Channel

  • Id: The id (unique integer) of this Channel.

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

Definition at line 45 of file uan-channel.h.

Member Typedef Documentation

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 52 of file uan-channel.h.

Constructor & Destructor Documentation

ns3::UanChannel::UanChannel ( )

Constructor.

Definition at line 69 of file uan-channel.cc.

ns3::UanChannel::~UanChannel ( )
virtual

Dummy destructor, see DoDispose.

Definition at line 76 of file uan-channel.cc.

Member Function Documentation

void ns3::UanChannel::AddDevice ( Ptr< UanNetDevice dev,
Ptr< UanTransducer trans 
)

Adds device to receiver list for this channel.

Parameters
devNet Device of node.
transTransducer of net device attached to this channel.

Definition at line 142 of file uan-channel.cc.

References m_devList, and NS_LOG_DEBUG.

void ns3::UanChannel::Clear ( void  )

Clear all pointer references.

Definition at line 81 of file uan-channel.cc.

References m_cleared, m_devList, m_noise, and m_prop.

Referenced by DoDispose().

+ Here is the caller graph for this function:

void ns3::UanChannel::DoDispose ( void  )
protectedvirtual

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 overriden 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 117 of file uan-channel.cc.

References Clear(), and ns3::Object::DoDispose().

+ Here is the call graph for this function:

Ptr< NetDevice > ns3::UanChannel::GetDevice ( uint32_t  i) const
virtual
Parameters
iindex of NetDevice to retrieve
Returns
one of the NetDevices connected to this channel.

This method must be implemented by subclasses.

Implements ns3::Channel.

Definition at line 136 of file uan-channel.cc.

References m_devList.

uint32_t ns3::UanChannel::GetNDevices ( void  ) const
virtual
Returns
the number of NetDevices connected to this Channel.

This method must be implemented by subclasses.

Implements ns3::Channel.

Definition at line 130 of file uan-channel.cc.

References m_devList.

double ns3::UanChannel::GetNoiseDbHz ( double  fKhz)

Get the noise level on the channel.

Parameters
fKhzFrequency in kHz.
Returns
Ambient noise in dB/Hz on channel at a frequency.

Definition at line 215 of file uan-channel.cc.

References m_noise, and NS_ASSERT.

TypeId ns3::UanChannel::GetTypeId ( void  )
static

Register this type.

Returns
The object TypeId.

Definition at line 48 of file uan-channel.cc.

References m_noise, m_prop, ns3::MakePointerAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

void ns3::UanChannel::SendUp ( uint32_t  i,
Ptr< Packet packet,
double  rxPowerDb,
UanTxMode  txMode,
UanPdp  pdp 
)
private

Send a packet up to the receiving UanTransducer.

Parameters
iDevice number.
packetThe received packet.
rxPowerDbSignal power in dB of arriving packet.
txModeMode arriving packet is using.
pdpPDP of arriving signal.

Definition at line 207 of file uan-channel.cc.

References m_devList, and NS_LOG_DEBUG.

Referenced by TxPacket().

+ Here is the caller graph for this function:

void ns3::UanChannel::SetNoiseModel ( Ptr< UanNoiseModel noise)

Set the noise model this channel will use to determine ambient channel noise.

Parameters
noiseThe noise model.

Definition at line 201 of file uan-channel.cc.

References m_noise, and NS_ASSERT.

void ns3::UanChannel::SetPropagationModel ( Ptr< UanPropModel prop)

Set the propagation model this channel will use for path loss/propagation delay.

Parameters
propThe propagation model.

Definition at line 123 of file uan-channel.cc.

References m_prop, and NS_LOG_DEBUG.

void ns3::UanChannel::TxPacket ( Ptr< UanTransducer src,
Ptr< Packet packet,
double  txPowerDb,
UanTxMode  txmode 
)

Send a packet out on the channel.

Parameters
srcTransducer transmitting packet.
packetPacket to be transmitted.
txPowerDbTransmission power in dB.
txmodeUanTxMode defining modulation of transmitted packet.

Definition at line 149 of file uan-channel.cc.

References ns3::Packet::Copy(), ns3::MobilityModel::GetDistanceFrom(), ns3::Object::GetObject(), m_devList, m_prop, NS_ASSERT, NS_LOG_DEBUG, ns3::Simulator::ScheduleWithContext(), and SendUp().

+ Here is the call graph for this function:

Member Data Documentation

bool ns3::UanChannel::m_cleared
private

Has Clear ever been called on the channel.

Definition at line 119 of file uan-channel.h.

Referenced by Clear().

UanDeviceList ns3::UanChannel::m_devList
private

The list of devices on this channel.

Definition at line 115 of file uan-channel.h.

Referenced by AddDevice(), Clear(), GetDevice(), GetNDevices(), SendUp(), and TxPacket().

Ptr<UanNoiseModel> ns3::UanChannel::m_noise
private

The noise model.

Definition at line 117 of file uan-channel.h.

Referenced by Clear(), GetNoiseDbHz(), GetTypeId(), and SetNoiseModel().

Ptr<UanPropModel> ns3::UanChannel::m_prop
private

The propagation model.

Definition at line 116 of file uan-channel.h.

Referenced by Clear(), GetTypeId(), SetPropagationModel(), and TxPacket().


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