helps to manage and create IEEE 802.15.4 NetDevice objects More...

#include <lr-wpan-helper.h>

Inheritance diagram for ns3::LrWpanHelper:

Collaboration diagram for ns3::LrWpanHelper:

Public Member Functions
	LrWpanHelper (void)
	Create a LrWpan helper in an empty state. More...

virtual	~LrWpanHelper (void)

void	AddMobility (Ptr< LrWpanPhy > phy, Ptr< MobilityModel > m)
	Add mobility model to a physical device. 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...

void	AssociateToPan (NetDeviceContainer c, uint16_t panId)
	Associate the nodes to the same PAN. More...

void	EnableLogComponents (void)
	Helper to enable all LrWpan log components with one statement. More...

NetDeviceContainer	Install (NodeContainer c)
	Install a LrWpanNetDevice and the associated structures (e.g., channel) in the nodes. More...

Public Member Functions inherited from ns3::PcapHelperForDevice
	PcapHelperForDevice ()
	Construct a PcapHelperForDevice. More...

virtual	~PcapHelperForDevice ()
	Destroy a PcapHelperForDevice. More...

void	EnablePcap (std::string prefix, Ptr< NetDevice > nd, bool promiscuous=false, bool explicitFilename=false)
	Enable pcap output the indicated net device. More...

void	EnablePcap (std::string prefix, std::string ndName, bool promiscuous=false, bool explicitFilename=false)
	Enable pcap output the indicated net device using a device previously named using the ns-3 object name service. More...

void	EnablePcap (std::string prefix, NetDeviceContainer d, bool promiscuous=false)
	Enable pcap output on each device in the container which is of the appropriate type. More...

void	EnablePcap (std::string prefix, NodeContainer n, bool promiscuous=false)
	Enable pcap output on each device (which is of the appropriate type) in the nodes provided in the container. More...

void	EnablePcap (std::string prefix, uint32_t nodeid, uint32_t deviceid, bool promiscuous=false)
	Enable pcap output on the device specified by a global node-id (of a previously created node) and associated device-id. More...

void	EnablePcapAll (std::string prefix, bool promiscuous=false)
	Enable pcap output on each device (which is of the appropriate type) in the set of all nodes created in the simulation. More...

Public Member Functions inherited from ns3::AsciiTraceHelperForDevice
	AsciiTraceHelperForDevice ()
	Construct an AsciiTraceHelperForDevice. More...

virtual	~AsciiTraceHelperForDevice ()
	Destroy an AsciiTraceHelperForDevice. More...

void	EnableAscii (std::string prefix, Ptr< NetDevice > nd, bool explicitFilename=false)
	Enable ascii trace output on the indicated net device. More...

void	EnableAscii (Ptr< OutputStreamWrapper > stream, Ptr< NetDevice > nd)
	Enable ascii trace output on the indicated net device. More...

void	EnableAscii (std::string prefix, std::string ndName, bool explicitFilename=false)
	Enable ascii trace output the indicated net device using a device previously named using the ns-3 object name service. More...

void	EnableAscii (Ptr< OutputStreamWrapper > stream, std::string ndName)
	Enable ascii trace output the indicated net device using a device previously named using the ns-3 object name service. More...

void	EnableAscii (std::string prefix, NetDeviceContainer d)
	Enable ascii trace output on each device in the container which is of the appropriate type. More...

void	EnableAscii (Ptr< OutputStreamWrapper > stream, NetDeviceContainer d)
	Enable ascii trace output on each device in the container which is of the appropriate type. More...

void	EnableAscii (std::string prefix, NodeContainer n)
	Enable ascii trace output on each device (which is of the appropriate type) in the nodes provided in the container. More...

void	EnableAscii (Ptr< OutputStreamWrapper > stream, NodeContainer n)
	Enable ascii trace output on each device (which is of the appropriate type) in the nodes provided in the container. More...

void	EnableAscii (std::string prefix, uint32_t nodeid, uint32_t deviceid, bool explicitFilename)
	Enable ascii trace output on the device specified by a global node-id (of a previously created node) and associated device-id. More...

void	EnableAscii (Ptr< OutputStreamWrapper > stream, uint32_t nodeid, uint32_t deviceid)
	Enable ascii trace output on the device specified by a global node-id (of a previously created node) and associated device-id. More...

void	EnableAsciiAll (std::string prefix)
	Enable ascii trace output on each device (which is of the appropriate type) in the set of all nodes created in the simulation. More...

void	EnableAsciiAll (Ptr< OutputStreamWrapper > stream)
	Enable ascii trace output on each device (which is of the appropriate type) in the set of all nodes created in the simulation. More...

Static Public Member Functions
static std::string	LrWpanMacStatePrinter (LrWpanMacState e)
	Transform the LrWpanMacState enumeration into a printable string. More...

static std::string	LrWpanPhyEnumerationPrinter (LrWpanPhyEnumeration e)
	Transform the LrWpanPhyEnumeration enumeration into a printable string. More...

Private Member Functions
	LrWpanHelper (LrWpanHelper const &)
	Copy constructor - defined and not implemented. More...

virtual void	EnableAsciiInternal (Ptr< OutputStreamWrapper > stream, std::string prefix, Ptr< NetDevice > nd, bool explicitFilename)
	Enable ascii trace output on the indicated net device. More...

virtual void	EnablePcapInternal (std::string prefix, Ptr< NetDevice > nd, bool promiscuous, bool explicitFilename)
	Enable pcap output on the indicated net device. More...

LrWpanHelper &	operator= (LrWpanHelper const &)
	Copy constructor - defined and not implemented. More...

Private Attributes
Ptr< SingleModelSpectrumChannel >	m_channel
	channel to be used for the devices More...

Detailed Description

helps to manage and create IEEE 802.15.4 NetDevice objects

This class can help to create IEEE 802.15.4 NetDevice objects and to configure their attributes during creation. It also contains additional helper functions used by client code.

Definition at line 45 of file lr-wpan-helper.h.

Constructor & Destructor Documentation

ns3::LrWpanHelper::LrWpanHelper ( void )

Create a LrWpan helper in an empty state.

Definition at line 63 of file lr-wpan-helper.cc.

References m_channel.

ns3::LrWpanHelper::~LrWpanHelper ( void )

virtual

Definition at line 70 of file lr-wpan-helper.cc.

References m_channel.

ns3::LrWpanHelper::LrWpanHelper ( LrWpanHelper const & )

private

Copy constructor - defined and not implemented.

Member Function Documentation

void ns3::LrWpanHelper::AddMobility	(	Ptr< LrWpanPhy >	phy,
		Ptr< MobilityModel >	m
	)

Add mobility model to a physical device.

Parameters

phy	the physical device
m	the mobility model

Definition at line 146 of file lr-wpan-helper.cc.

int64_t ns3::LrWpanHelper::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 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 CsmaNetDevice 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 171 of file lr-wpan-helper.cc.

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

Here is the call graph for this function:

void ns3::LrWpanHelper::AssociateToPan	(	NetDeviceContainer	c,
		uint16_t	panId
	)

Associate the nodes to the same PAN.

Parameters

c	a set of nodes
panId	the PAN Id

Definition at line 188 of file lr-wpan-helper.cc.

References first::address, ns3::NetDeviceContainer::Begin(), ns3::Mac16Address::CopyFrom(), first::devices, and ns3::NetDeviceContainer::End().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::LrWpanHelper::EnableAsciiInternal	(	Ptr< OutputStreamWrapper >	stream,
		std::string	prefix,
		Ptr< NetDevice >	nd,
		bool	explicitFilename
	)

privatevirtual

Enable ascii trace output on the indicated net device.

Internal:

NetDevice-specific implementation mechanism for hooking the trace and writing to the trace file.

Parameters

stream	The output stream object to use when logging ascii traces.
prefix	Filename prefix to use for ascii trace files.
nd	Net device for which you want to enable tracing.
explicitFilename	Treat the prefix as an explicit filename if true

Implements ns3::AsciiTraceHelperForDevice.

Definition at line 271 of file lr-wpan-helper.cc.

Here is the call graph for this function:

void ns3::LrWpanHelper::EnableLogComponents ( void )

Helper to enable all LrWpan log components with one statement.

Definition at line 77 of file lr-wpan-helper.cc.

References ns3::LOG_LEVEL_ALL, ns3::LOG_PREFIX_FUNC, ns3::LOG_PREFIX_TIME, ns3::LogComponentEnable(), and ns3::LogComponentEnableAll().

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::LrWpanHelper::EnablePcapInternal	(	std::string	prefix,
		Ptr< NetDevice >	nd,
		bool	promiscuous,
		bool	explicitFilename
	)

privatevirtual

Enable pcap output on the indicated net device.

Internal:

Internal:

NetDevice-specific implementation mechanism for hooking the trace and writing to the trace file.

Parameters

prefix	Filename prefix to use for pcap files.
nd	Net device for which you want to enable tracing.
promiscuous	If true capture all possible packets available at the device.
explicitFilename	Treat the prefix as an explicit filename if true

Implements ns3::PcapHelperForDevice.

Definition at line 224 of file lr-wpan-helper.cc.

References ns3::PcapHelper::CreateFile(), ns3::PcapHelper::DLT_IEEE802_15_4, ns3::PcapHelper::GetFilenameFromDevice(), ns3::MakeBoundCallback(), NS_LOG_FUNCTION, NS_LOG_INFO, and ns3::PcapSniffLrWpan().

Here is the call graph for this function: