A simple channel, for simple things and testing. More...

#include "simple-channel.h"

Inheritance diagram for ns3::SimpleChannel:

Collaboration diagram for ns3::SimpleChannel:

Public Member Functions
	SimpleChannel ()

virtual void	Add (Ptr< SimpleNetDevice > device)
	Attached a net device to the channel. More...

virtual void	BlackList (Ptr< SimpleNetDevice > from, Ptr< SimpleNetDevice > to)
	Blocks the communications from a NetDevice to another NetDevice. More...

virtual Ptr< NetDevice >	GetDevice (std::size_t i) const

virtual std::size_t	GetNDevices (void) const

virtual void	Send (Ptr< Packet > p, uint16_t protocol, Mac48Address to, Mac48Address from, Ptr< SimpleNetDevice > sender)
	A packet is sent by a net device. More...

virtual void	UnBlackList (Ptr< SimpleNetDevice > from, Ptr< SimpleNetDevice > to)
	Un-Blocks the communications from a NetDevice to another NetDevice. 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
	Get the most derived TypeId for this Object. More...

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. More...

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object. More...

template<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. More...

void	Initialize (void)
	Invoke DoInitialize on all Objects aggregated to this one. More...

bool	IsInitialized (void) const
	Check if the object has been initialized. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor. More...

	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= ([[maybe_unused]] const SimpleRefCount &o)
	Assignment operator. 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)
	Get the type ID. 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::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Private Attributes
std::map< Ptr< SimpleNetDevice >, std::vector< Ptr< SimpleNetDevice > > >	m_blackListedDevices
	devices blocked on a device More...

Time	m_delay
	The assigned speed-of-light delay of the channel. More...

std::vector< Ptr< SimpleNetDevice > >	m_devices
	devices connected by the channel 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...

Detailed Description

A simple channel, for simple things and testing.

This channel doesn't check for packet collisions and it does not introduce any error. By default, it does not add any delay to the packets. Furthermore, it assumes that the associated NetDevices are using 48-bit MAC addresses.

This channel is meant to be used by ns3::SimpleNetDevices.

Config Paths

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

"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::SimpleChannel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::SimpleChannel"
"/ChannelList/[i]/$ns3::SimpleChannel"

Attributes

Delay: Transmission delay through the channel
- Set with class: ns3::TimeValue
- Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
- Initial value: +0ns
- 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.
Size of this type is 112 bytes (on a 64-bit architecture).

Definition at line 46 of file simple-channel.h.

Constructor & Destructor Documentation

◆ SimpleChannel()

ns3::SimpleChannel::SimpleChannel ( )

Definition at line 49 of file simple-channel.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ Add()

void ns3::SimpleChannel::Add ( Ptr< SimpleNetDevice > device )

virtual

Attached a net device to the channel.

Parameters

device the device to attach to the channel

Reimplemented in ns3::ErrorChannel.

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

References m_devices, and NS_LOG_FUNCTION.

◆ BlackList()

void ns3::SimpleChannel::BlackList	(	Ptr< SimpleNetDevice >	from,
		Ptr< SimpleNetDevice >	to
	)

virtual

Blocks the communications from a NetDevice to another NetDevice.

The block is unidirectional

Parameters

from	the device to BlackList
to	the device wanting to block the other one

Definition at line 102 of file simple-channel.cc.

References m_blackListedDevices.

Referenced by ns3::olsr::Bug780Test::CreateNodes().

Here is the caller graph for this function:

◆ GetDevice()

Ptr< NetDevice > ns3::SimpleChannel::GetDevice ( std::size_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.

Reimplemented in ns3::ErrorChannel.

Definition at line 95 of file simple-channel.cc.

References m_devices, and NS_LOG_FUNCTION.

◆ GetNDevices()

std::size_t ns3::SimpleChannel::GetNDevices ( void ) const

virtual

Returns: the number of NetDevices connected to this Channel.

This method must be implemented by subclasses.

Implements ns3::Channel.

Reimplemented in ns3::ErrorChannel.

Definition at line 88 of file simple-channel.cc.

References m_devices, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::SimpleChannel::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 35 of file simple-channel.cc.

References m_delay, ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::Seconds(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ Send()

void ns3::SimpleChannel::Send	(	Ptr< Packet >	p,
		uint16_t	protocol,
		Mac48Address	to,
		Mac48Address	from,
		Ptr< SimpleNetDevice >	sender
	)

virtual

A packet is sent by a net device.

A receive event will be scheduled for all net device connected to the channel other than the net device who sent the packet

Parameters

p	packet to be sent
protocol	protocol number
to	address to send packet to
from	address the packet is coming from
sender	netdevice who sent the packet

Reimplemented in ns3::ErrorChannel.

Definition at line 55 of file simple-channel.cc.

References ns3::Packet::Copy(), m_blackListedDevices, m_delay, m_devices, NS_LOG_FUNCTION, ns3::SimpleNetDevice::Receive(), and ns3::Simulator::ScheduleWithContext().

Here is the call graph for this function:

◆ UnBlackList()

void ns3::SimpleChannel::UnBlackList	(	Ptr< SimpleNetDevice >	from,
		Ptr< SimpleNetDevice >	to
	)

virtual

Un-Blocks the communications from a NetDevice to another NetDevice.

The block is unidirectional

Parameters

from	the device to BlackList
to	the device wanting to block the other one

Definition at line 119 of file simple-channel.cc.

References m_blackListedDevices.

Member Data Documentation

◆ m_blackListedDevices

std::map<Ptr<SimpleNetDevice>, std::vector<Ptr<SimpleNetDevice> > > ns3::SimpleChannel::m_blackListedDevices

private

devices blocked on a device

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

Referenced by BlackList(), Send(), and UnBlackList().

◆ m_delay

Time ns3::SimpleChannel::m_delay

private

The assigned speed-of-light delay of the channel.

Definition at line 101 of file simple-channel.h.

Referenced by GetTypeId(), and Send().

◆ m_devices

std::vector<Ptr<SimpleNetDevice> > ns3::SimpleChannel::m_devices

private

devices connected by the channel

Definition at line 102 of file simple-channel.h.

Referenced by Add(), GetDevice(), GetNDevices(), and Send().

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

src/network/utils/simple-channel.h
src/network/utils/simple-channel.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Attributes defined in parent class ns3::Channel

Constructor & Destructor Documentation

◆ SimpleChannel()

Member Function Documentation

◆ Add()

◆ BlackList()

◆ GetDevice()

◆ GetNDevices()

◆ GetTypeId()

◆ Send()

◆ UnBlackList()

Member Data Documentation

◆ m_blackListedDevices

◆ m_delay

◆ m_devices