ns3::CsmaHelper Class Reference

build a set of CsmaNetDevice objects More...

#include <csma-helper.h>

Collaboration diagram for ns3::CsmaHelper:

List of all members.

Public Member Functions
void	SetQueue (std::string type, std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue())
void	SetDeviceAttribute (std::string n1, const AttributeValue &v1)
void	SetChannelAttribute (std::string n1, const AttributeValue &v1)
NetDeviceContainer	Install (const NodeContainer &c)
NetDeviceContainer	Install (const NodeContainer &c, Ptr< CsmaChannel > channel)
Static Public Member Functions
static void	EnablePcap (std::string filename, uint32_t nodeid, uint32_t deviceid)
static void	EnablePcap (std::string filename, NetDeviceContainer d)
static void	EnablePcap (std::string filename, NodeContainer n)
static void	EnablePcapAll (std::string filename)
static void	EnableAscii (std::ostream &os, uint32_t nodeid, uint32_t deviceid)
static void	EnableAscii (std::ostream &os, NetDeviceContainer d)
static void	EnableAscii (std::ostream &os, NodeContainer n)
static void	EnableAsciiAll (std::ostream &os)

---

Detailed Description

build a set of CsmaNetDevice objects

---

Member Function Documentation

static void ns3::CsmaHelper::EnableAscii	(	std::ostream &	os,
		uint32_t	nodeid,
		uint32_t	deviceid
	)			[static]

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.

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

static void ns3::CsmaHelper::EnableAscii	(	std::ostream &	os,
		NetDeviceContainer	d
	)			[static]

Parameters:

	os	output stream
	d	device container

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

static void ns3::CsmaHelper::EnableAscii	(	std::ostream &	os,
		NodeContainer	n
	)			[static]

Parameters:

	os	output stream
	n	node container

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

static void ns3::CsmaHelper::EnableAsciiAll

(

std::ostream &

os

)

[static]

Parameters:

os

output stream

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

static void ns3::CsmaHelper::EnablePcap	(	std::string	filename,
		uint32_t	nodeid,
		uint32_t	deviceid
	)			[static]

Parameters:

	filename	filename prefix to use for pcap files.
	nodeid	the id of the node to generate pcap output for.
	deviceid	the id of the device to generate pcap output for.

Generate a pcap file which contains the link-level data observed by the specified deviceid within the specified nodeid. The pcap data is stored in the file prefix-nodeid-deviceid.pcap.

This method should be invoked after the network topology has been fully constructed.

static void ns3::CsmaHelper::EnablePcap	(	std::string	filename,
		NodeContainer	n
	)			[static]

Parameters:

	filename	filename prefix to use for pcap files.
	n	container of nodes.

Enable pcap output on each device which is of the ns3::CsmaNetDevice type and which is located in one of the input nodes.

static void ns3::CsmaHelper::EnablePcap	(	std::string	filename,
		NetDeviceContainer	d
	)			[static]

Parameters:

	filename	filename prefix to use for pcap files.
	d	container of devices of type ns3::CsmaNetDevice

Enable pcap output on each input device which is of the ns3::CsmaNetDevice type.

static void ns3::CsmaHelper::EnablePcapAll

(

std::string

filename

)

[static]

Parameters:

filename

filename prefix to use for pcap files.

Enable pcap output on each device which is of the ns3::CsmaNetDevice type

NetDeviceContainer ns3::CsmaHelper::Install	(	const NodeContainer &	c,
		Ptr< CsmaChannel >	channel
	)

Parameters:

	c	a set of nodes
	channel	the channel to use as a backbone.

For each node in the input container, we create a ns3::CsmaNetDevice with the requested attributes, a queue for this NetDevice, and associate the resulting ns3::NetDevice with the ns3::Node and ns3::CsmaChannel.

NetDeviceContainer ns3::CsmaHelper::Install

(

const NodeContainer &

c

)

Parameters:

c

a set of nodes

This method creates a simple ns3::CsmaChannel with the attributes configured by CsmaHelper::SetChannelAttribute and then calls CsmaHelper::Install.

void ns3::CsmaHelper::SetChannelAttribute	(	std::string	n1,
		const AttributeValue &	v1
	)

Parameters:

	n1	the name of the attribute to set
	v1	the value of the attribute to set

Set these attributes on each ns3::CsmaChannel created by CsmaHelper::Install

void ns3::CsmaHelper::SetDeviceAttribute	(	std::string	n1,
		const AttributeValue &	v1
	)

Parameters:

	n1	the name of the attribute to set
	v1	the value of the attribute to set

Set these attributes on each ns3::CsmaNetDevice created by CsmaHelper::Install

void ns3::CsmaHelper::SetQueue	(	std::string	type,
		std::string	n1 = "",
		const AttributeValue &	v1 = EmptyAttributeValue(),
		std::string	n2 = "",
		const AttributeValue &	v2 = EmptyAttributeValue(),
		std::string	n3 = "",
		const AttributeValue &	v3 = EmptyAttributeValue(),
		std::string	n4 = "",
		const AttributeValue &	v4 = EmptyAttributeValue()
	)

Parameters:

	type	the type of queue
	n1	the name of the attribute to set on the queue
	v1	the value of the attribute to set on the queue
	n2	the name of the attribute to set on the queue
	v2	the value of the attribute to set on the queue
	n3	the name of the attribute to set on the queue
	v3	the value of the attribute to set on the queue
	n4	the name of the attribute to set on the queue
	v4	the value of the attribute to set on the queue

Set the type of queue to create and associated to each CsmaNetDevice created through CsmaHelper::Install.

---

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

• src/helper/csma-helper.h