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 ()

virtual	~UanChannel ()

void	AddDevice (Ptr< UanNetDevice > dev, Ptr< UanTransducer > trans)

void	Clear (void)

virtual Ptr< NetDevice >	GetDevice (uint32_t i) const

virtual uint32_t	GetNDevices (void) const

double	GetNoiseDbHz (double fKhz)

void	SetNoiseModel (Ptr< UanNoiseModel > noise)

void	SetPropagationModel (Ptr< UanPropModel > prop)

void	TxPacket (Ptr< UanTransducer > src, Ptr< Packet > packet, double txPowerDb, UanTxMode txmode)

Public Member Functions inherited from ns3::Channel
	Channel ()

virtual	~Channel ()

uint32_t	GetId (void) const

Public Member Functions inherited from ns3::Object
	Object ()

virtual	~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 ()

	SimpleRefCount (const SimpleRefCount &o)

uint32_t	GetReferenceCount (void) const

SimpleRefCount &	operator= (const SimpleRefCount &o)

void	Ref (void) const

void	Unref (void) const

Public Member Functions inherited from ns3::ObjectBase
virtual	~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 ()

Static Public Member Functions inherited from ns3::Channel
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)

Protected Member Functions
virtual void	DoDispose ()

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

virtual void	DoInitialize (void)

virtual void	NotifyNewAggregate (void)

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)

Private Member Functions
void	SendUp (uint32_t i, Ptr< Packet > packet, double rxPowerDb, UanTxMode txMode, UanPdp pdp)

Private Attributes
bool	m_cleared

UanDeviceList	m_devList

Ptr< UanNoiseModel >	m_noise

Ptr< UanPropModel >	m_prop

Detailed Description

Channel class used by UAN devices.

Config Paths

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

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

Attributes

PropagationModel: A pointer to the propagation model.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::UanPropModel >
- Initial value: 0x1e32260
- Flags: construct write read
NoiseModel: A pointer to the model of the channel ambient noise.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::UanNoiseModel >
- Initial value: 0x1e32130
- Flags: construct write read

Attributes defined in parent class ns3::Channel

Id: The id (unique integer) of this Channel.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Flags: read

No TraceSources are defined for this type.

Definition at line 44 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 50 of file uan-channel.h.

Constructor & Destructor Documentation

ns3::UanChannel::UanChannel ( )

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

ns3::UanChannel::~UanChannel ( )

virtual

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

Member Function Documentation

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

Parameters

dev	Net Device of node
trans	Transducer of net device attached to this channel

Adds device to receiver list for this channel

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

References m_devList, and NS_LOG_DEBUG.

void ns3::UanChannel::Clear ( void )

Clears all pointer references

Definition at line 78 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

This method is called by Object::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 114 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

i	index 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 133 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 127 of file uan-channel.cc.

References m_devList.

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

Parameters

fKhz	Frequency in kHz

Returns: Ambient noise in dB/Hz on channel at a frequency

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

References m_noise, and NS_ASSERT.

TypeId ns3::UanChannel::GetTypeId ( void )

static

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

References m_noise, m_prop, 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

Definition at line 204 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 )

Parameters

noise Noise model this channel will use to determine ambient channel noise.

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

References m_noise, and NS_ASSERT.

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

Parameters

prop	Propagation model this channel will use for path loss/propagation delay

Definition at line 120 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
	)

Parameters

src	Transducer transmitting packet
packet	Packet to be transmitted
txPowerDb	Transmission power in dB
txmode	UanTxMode defining modulation of transmitted packet Send a packet out on the channel

Definition at line 146 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

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

Referenced by Clear().

UanDeviceList ns3::UanChannel::m_devList

private

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

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

Ptr<UanNoiseModel> ns3::UanChannel::m_noise

private

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

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

Ptr<UanPropModel> ns3::UanChannel::m_prop

private

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

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

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

src/uan/model/uan-channel.h
src/uan/model/uan-channel.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Config Paths

Attributes

Attributes defined in parent class ns3::Channel

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation