A Error channel, introducing deterministic delays on even/odd packets. More...

#include "error-channel.h"

Inheritance diagram for ns3::ErrorChannel:

Collaboration diagram for ns3::ErrorChannel:

Public Member Functions
	ErrorChannel ()

virtual void	Add (Ptr< SimpleNetDevice > device)
	Attached a net device to the channel. 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...

void	SetDuplicateMode (bool mode)
	Set if the odd packets are duplicated (even ones are not duplicated ever) More...

void	SetDuplicateTime (Time delay)
	Set the delay for the odd duplicate packets (even ones are not duplicated) More...

void	SetJumpingMode (bool mode)
	Set if the odd packets are delayed (even ones are not delayed ever) More...

void	SetJumpingTime (Time delay)
	Set the delay for the odd packets (even ones are not delayed) More...

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

virtual void	BlackList (Ptr< SimpleNetDevice > from, Ptr< SimpleNetDevice > to)
	Blocks the communications from a NetDevice to another NetDevice. 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<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...

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

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::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)
	Copy constructor. More...

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

SimpleRefCount &	operator= (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::SimpleChannel
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::vector< Ptr< SimpleNetDevice > >	m_devices
	devices connected by the channel More...

bool	m_duplicate
	Flag for Duplicate mode. More...

uint8_t	m_duplicateState
	Counter for even/odd packets in Duplicate mode. More...

Time	m_duplicateTime
	Duplicate time in Duplicate mode. More...

bool	m_jumping
	Flag for Jumping mode. More...

uint8_t	m_jumpingState
	Counter for even/odd packets in Jumping mode. More...

Time	m_jumpingTime
	Delay time in Jumping mode. 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 Error channel, introducing deterministic delays on even/odd packets.

Used for testing

Config Paths

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

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

No Attributes are defined for this type.

Attributes defined in parent class ns3::SimpleChannel

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 168 bytes (on a 64-bit architecture).

Definition at line 39 of file error-channel.h.

Constructor & Destructor Documentation

◆ ErrorChannel()

ns3::ErrorChannel::ErrorChannel ( )

Definition at line 45 of file error-channel.cc.

References m_duplicate, m_duplicateState, m_duplicateTime, m_jumping, m_jumpingState, m_jumpingTime, and ns3::Seconds().

Here is the call graph for this function:

Member Function Documentation

◆ Add()

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

virtual

Attached a net device to the channel.

Parameters

device the device to attach to the channel

Reimplemented from ns3::SimpleChannel.

Definition at line 133 of file error-channel.cc.

References m_devices.

◆ GetDevice()

Ptr< NetDevice > ns3::ErrorChannel::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.

Reimplemented from ns3::SimpleChannel.

Definition at line 145 of file error-channel.cc.

References m_devices.

◆ GetNDevices()

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

virtual

Returns: the number of NetDevices connected to this Channel.

This method must be implemented by subclasses.

Reimplemented from ns3::SimpleChannel.

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

References m_devices.

◆ GetTypeId()

TypeId ns3::ErrorChannel::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

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

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ Send()

void ns3::ErrorChannel::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 from ns3::SimpleChannel.

Definition at line 82 of file error-channel.cc.

References ns3::Packet::Copy(), m_devices, m_duplicate, m_duplicateState, m_duplicateTime, m_jumping, m_jumpingState, m_jumpingTime, NS_LOG_FUNCTION, ns3::SimpleNetDevice::Receive(), ns3::Simulator::ScheduleWithContext(), and ns3::Seconds().

Here is the call graph for this function:

◆ SetDuplicateMode()

void ns3::ErrorChannel::SetDuplicateMode ( bool mode )

Set if the odd packets are duplicated (even ones are not duplicated ever)

Parameters

mode	true if the odd packets should be duplicated.

Definition at line 75 of file error-channel.cc.

References m_duplicate, and m_duplicateState.

◆ SetDuplicateTime()

void ns3::ErrorChannel::SetDuplicateTime ( Time delay )

Set the delay for the odd duplicate packets (even ones are not duplicated)

Parameters

delay Delay for the odd packets.

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

References m_duplicateTime.

◆ SetJumpingMode()

void ns3::ErrorChannel::SetJumpingMode ( bool mode )

Set if the odd packets are delayed (even ones are not delayed ever)

Parameters

mode	true if the odd packets should be delayed.

Definition at line 62 of file error-channel.cc.

References m_jumping, and m_jumpingState.

◆ SetJumpingTime()

void ns3::ErrorChannel::SetJumpingTime ( Time delay )

Set the delay for the odd packets (even ones are not delayed)

Parameters

delay Delay for the odd packets.

Definition at line 56 of file error-channel.cc.

References m_jumpingTime.

Member Data Documentation

◆ m_devices

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

private

devices connected by the channel

Definition at line 84 of file error-channel.h.

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

◆ m_duplicate

bool ns3::ErrorChannel::m_duplicate

private

Flag for Duplicate mode.

Definition at line 89 of file error-channel.h.

Referenced by ErrorChannel(), Send(), and SetDuplicateMode().

◆ m_duplicateState

uint8_t ns3::ErrorChannel::m_duplicateState

private

Counter for even/odd packets in Duplicate mode.

Definition at line 90 of file error-channel.h.

Referenced by ErrorChannel(), Send(), and SetDuplicateMode().

◆ m_duplicateTime

Time ns3::ErrorChannel::m_duplicateTime

private

Duplicate time in Duplicate mode.

Definition at line 88 of file error-channel.h.

Referenced by ErrorChannel(), Send(), and SetDuplicateTime().

◆ m_jumping

bool ns3::ErrorChannel::m_jumping

private

Flag for Jumping mode.

Definition at line 87 of file error-channel.h.

Referenced by ErrorChannel(), Send(), and SetJumpingMode().

◆ m_jumpingState

uint8_t ns3::ErrorChannel::m_jumpingState

private

Counter for even/odd packets in Jumping mode.

Definition at line 86 of file error-channel.h.

Referenced by ErrorChannel(), Send(), and SetJumpingMode().

◆ m_jumpingTime

Time ns3::ErrorChannel::m_jumpingTime

private

Delay time in Jumping mode.

Definition at line 85 of file error-channel.h.

Referenced by ErrorChannel(), Send(), and SetJumpingTime().

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

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

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes defined in parent class ns3::SimpleChannel

Attributes defined in parent class ns3::Channel

Constructor & Destructor Documentation

◆ ErrorChannel()

Member Function Documentation

◆ Add()

◆ GetDevice()

◆ GetNDevices()

◆ GetTypeId()

◆ Send()

◆ SetDuplicateMode()

◆ SetDuplicateTime()

◆ SetJumpingMode()

◆ SetJumpingTime()

Member Data Documentation

◆ m_devices

◆ m_duplicate

◆ m_duplicateState

◆ m_duplicateTime

◆ m_jumping

◆ m_jumpingState

◆ m_jumpingTime