UAN configuration helper. More...

#include "uan-helper.h"

Collaboration diagram for ns3::UanHelper:

Public Member Functions
	UanHelper ()
	Default constructor. More...

virtual	~UanHelper ()
	Destructor. More...

int64_t	AssignStreams (NetDeviceContainer c, int64_t stream)
	Assign a fixed random variable stream number to the random variables used by this model. More...

NetDeviceContainer	Install (NodeContainer c) const
	This method creates a simple ns3::UanChannel (with a default ns3::UanNoiseModelDefault and ns3::UanPropModelIdeal) and creates, for each of the input nodes, a new ns3::UanNetDevice attached to this shared channel. More...

NetDeviceContainer	Install (NodeContainer c, Ptr< UanChannel > channel) const
	For each of the input nodes, a new ns3::UanNetDevice is attached to the shared input channel. More...

Ptr< UanNetDevice >	Install (Ptr< Node > node, Ptr< UanChannel > channel) const
	Create a default an stack. More...

template<typename... Ts>
void	SetMac (std::string type, Ts &&... args)
	Set MAC attributes. More...

template<typename... Ts>
void	SetPhy (std::string phyType, Ts &&... args)
	Set PHY attributes. More...

template<typename... Ts>
void	SetTransducer (std::string type, Ts &&... args)
	Set the transducer attributes. More...

Static Public Member Functions
static void	EnableAscii (std::ostream &os, NetDeviceContainer d)
	Enable ascii output on each device which is of the ns3::UanNetDevice type and which is located in the input device container and dump that to the specified stdc++ output stream. More...

static void	EnableAscii (std::ostream &os, NodeContainer n)
	Enable ascii output on each device which is of the ns3::UanNetDevice type and which is located in one of the input node and dump that to the specified stdc++ output stream. More...

static void	EnableAscii (std::ostream &os, uint32_t nodeid, uint32_t deviceid)
	Enable ascii output on the specified deviceid within the specified nodeid if it is of type ns3::UanNetDevice and dump that to the specified stdc++ output stream. More...

static void	EnableAsciiAll (std::ostream &os)
	Enable ascii output on each device which is of the ns3::UanNetDevice type and dump that to the specified stdc++ output stream. More...

Private Attributes
ObjectFactory	m_device
	The device. More...

ObjectFactory	m_mac
	The MAC layer. More...

ObjectFactory	m_phy
	The PHY layer. More...

ObjectFactory	m_transducer
	The transducer. More...

Detailed Description

UAN configuration helper.

Definition at line 41 of file uan-helper.h.

Constructor & Destructor Documentation

◆ UanHelper()

ns3::UanHelper::UanHelper ( )

Default constructor.

Definition at line 87 of file uan-helper.cc.

References m_mac, m_phy, m_transducer, and ns3::ObjectFactory::SetTypeId().

Here is the call graph for this function:

◆ ~UanHelper()

ns3::UanHelper::~UanHelper ( )

virtual

Destructor.

Definition at line 94 of file uan-helper.cc.

Member Function Documentation

◆ AssignStreams()

int64_t ns3::UanHelper::AssignStreams	(	NetDeviceContainer	c,
		int64_t	stream
	)

Assign a fixed random variable stream number to the random variables used by this model.

Return the number of streams (possibly zero) that have been assigned. The Install() method should have previously been called by the user.

Parameters

c	NetDeviceContainer of the set of net devices for which the UanNetDevice should be modified to use a fixed stream.
stream	First stream index to use.

Returns: The number of stream indices assigned by this helper.

Definition at line 192 of file uan-helper.cc.

References ns3::NetDeviceContainer::Begin(), and ns3::NetDeviceContainer::End().

Here is the call graph for this function:

◆ EnableAscii() [1/3]

void ns3::UanHelper::EnableAscii	(	std::ostream &	os,
		NetDeviceContainer	d
	)

static

Enable ascii output on each device which is of the ns3::UanNetDevice type and which is located in the input device container and dump that to the specified stdc++ output stream.

Parameters

os	Output stream.
d	Device container.

Definition at line 114 of file uan-helper.cc.

References ns3::NetDeviceContainer::Begin(), EnableAscii(), and ns3::NetDeviceContainer::End().

Here is the call graph for this function:

◆ EnableAscii() [2/3]

void ns3::UanHelper::EnableAscii	(	std::ostream &	os,
		NodeContainer	n
	)

static

Enable ascii output on each device which is of the ns3::UanNetDevice type and which is located in one of the input node and dump that to the specified stdc++ output stream.

Parameters

os	Output stream.
n	Node container.

Definition at line 124 of file uan-helper.cc.

References ns3::NetDeviceContainer::Add(), ns3::NodeContainer::Begin(), EnableAscii(), ns3::NodeContainer::End(), ns3::Node::GetDevice(), and ns3::Node::GetNDevices().

Here is the call graph for this function:

◆ EnableAscii() [3/3]

void ns3::UanHelper::EnableAscii	(	std::ostream &	os,
		uint32_t	nodeid,
		uint32_t	deviceid
	)

static

Enable ascii output on the specified deviceid within the specified nodeid if it is of type ns3::UanNetDevice and dump that to the specified stdc++ output stream.

Parameters

os	Output stream.
nodeid	The id of the node to generate ascii output for.
deviceid	The id of the device to generate ascii output for.

Definition at line 99 of file uan-helper.cc.

References ns3::AsciiPhyRxOkEvent(), ns3::AsciiPhyTxEvent(), ns3::Config::Connect(), ns3::Packet::EnablePrinting(), and ns3::MakeBoundCallback().

Referenced by EnableAscii(), and EnableAsciiAll().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EnableAsciiAll()

void ns3::UanHelper::EnableAsciiAll ( std::ostream & os )

static

Enable ascii output on each device which is of the ns3::UanNetDevice type and dump that to the specified stdc++ output stream.

Parameters

os	Output stream.

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

References EnableAscii(), and ns3::NodeContainer::GetGlobal().

Here is the call graph for this function:

◆ Install() [1/3]

NetDeviceContainer ns3::UanHelper::Install ( NodeContainer c ) const

This method creates a simple ns3::UanChannel (with a default ns3::UanNoiseModelDefault and ns3::UanPropModelIdeal) and creates, for each of the input nodes, a new ns3::UanNetDevice attached to this shared channel.

Each ns3::UanNetDevice is also configured with an ns3::UanTransducerHd, ns3::UanMac, and, ns3::UanPhy, all of which are created based on the user-specified attributes specified in UanHelper::SetTransducer, UanHelper::SetMac, and, UanHelper::SetPhy.

Parameters

c	A set of nodes.

Returns: The installed netdevices.

Definition at line 145 of file uan-helper.cc.

References third::channel.

Referenced by AcousticModemEnergyTestCase::DoRun(), AcousticModemEnergyDepletionTestCase::DoRun(), Install(), NetAnimExperiment::Run(), Experiment::Run(), and UanExperiment::SetupCommunications().

Here is the caller graph for this function:

◆ Install() [2/3]

NetDeviceContainer ns3::UanHelper::Install	(	NodeContainer	c,
		Ptr< UanChannel >	channel
	)		const

For each of the input nodes, a new ns3::UanNetDevice is attached to the shared input channel.

Each ns3::UanNetDevice is also configured with an ns3::UanTransducerHd, a ns3::UanMac, and ns3::UanPhy, all of which are created based on the user-specified attributes specified in UanHelper::SetTransducer, UanHelper::SetMac, and UanHelper::SetPhy.

Parameters

c	A set of nodes.
channel	A channel to use.

Returns: The installed netdevices.

Definition at line 156 of file uan-helper.cc.

References ns3::NodeContainer::Begin(), third::channel, first::devices, ns3::NodeContainer::End(), ns3::Object::GetObject(), Install(), and NS_LOG_DEBUG.

Here is the call graph for this function:

◆ Install() [3/3]

Ptr< UanNetDevice > ns3::UanHelper::Install	(	Ptr< Node >	node,
		Ptr< UanChannel >	channel
	)		const

Create a default an stack.

The stack includes:

default channel, ideal propagation and default noise model.
default physical layer, with UanPhyGen.
default transducer, half duplex acoustic modem with UanTransducerHd.
default MAC layer, with UanMacAloha.

Channel, physical layer, transducer and mac layer are added to the UanNetDevice and then added to the node.

Parameters

node	A node where to install the uan components.
channel	A channel to use.

Returns: The installed UanNetDevice.

Definition at line 172 of file uan-helper.cc.

References ns3::Node::AddDevice(), ns3::Mac8Address::Allocate(), third::channel, ns3::ObjectFactory::Create(), m_mac, m_phy, m_transducer, third::mac, and third::phy.

Here is the call graph for this function:

◆ SetMac()

template<typename... Ts>

void ns3::UanHelper::SetMac	(	std::string	type,
		Ts &&...	args
	)

Set MAC attributes.

Template Parameters

Ts	[deduced] Argument types

Parameters

	type	The type of ns3::UanMac to create.
[in]	args	Name and AttributeValue pairs to set.

All the attributes specified in this method should exist in the requested mac.

Definition at line 197 of file uan-helper.h.

References check-style-clang-format::args, m_mac, and check-style-clang-format::type.

Referenced by NetAnimExperiment::Run(), and Experiment::Run().

Here is the caller graph for this function:

◆ SetPhy()

template<typename... Ts>

void ns3::UanHelper::SetPhy	(	std::string	phyType,
		Ts &&...	args
	)

Set PHY attributes.

Template Parameters

Ts	[deduced] Argument types

Parameters

	phyType	The type of ns3::UanPhy to create.
[in]	args	Name and AttributeValue pairs to set.

All the attributes specified in this method should exist in the requested Phy.

Definition at line 204 of file uan-helper.h.

References check-style-clang-format::args, and m_phy.

Referenced by Experiment::Run().

Here is the caller graph for this function:

◆ SetTransducer()

template<typename... Ts>

void ns3::UanHelper::SetTransducer	(	std::string	type,
		Ts &&...	args
	)

Set the transducer attributes.

Template Parameters

Ts	[deduced] Argument types

Parameters

	type	The type of ns3::Transducer to create.
[in]	args	Name and AttributeValue pairs to set.

All the attributes specified in this method should exist in the requested transducer.

Definition at line 211 of file uan-helper.h.

References check-style-clang-format::args, m_transducer, and check-style-clang-format::type.

Member Data Documentation

◆ m_device

ObjectFactory ns3::UanHelper::m_device

private

The device.

Definition at line 185 of file uan-helper.h.

◆ m_mac

ObjectFactory ns3::UanHelper::m_mac

private

The MAC layer.

Definition at line 186 of file uan-helper.h.

Referenced by UanHelper(), Install(), and SetMac().

◆ m_phy

ObjectFactory ns3::UanHelper::m_phy

private

The PHY layer.

Definition at line 187 of file uan-helper.h.

Referenced by UanHelper(), Install(), and SetPhy().

◆ m_transducer

ObjectFactory ns3::UanHelper::m_transducer

private

The transducer.

Definition at line 188 of file uan-helper.h.

Referenced by UanHelper(), Install(), and SetTransducer().

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

src/uan/helper/uan-helper.h
src/uan/helper/uan-helper.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ UanHelper()

◆ ~UanHelper()

Member Function Documentation

◆ AssignStreams()

◆ EnableAscii() [1/3]

◆ EnableAscii() [2/3]

◆ EnableAscii() [3/3]

◆ EnableAsciiAll()

◆ Install() [1/3]

◆ Install() [2/3]

◆ Install() [3/3]

◆ SetMac()

◆ SetPhy()

◆ SetTransducer()

Member Data Documentation

◆ m_device

◆ m_mac

◆ m_phy

◆ m_transducer