ns3::FlowMonitorHelper Class Reference

Helper to enable IPv4 flow monitoring on a set of Nodes. More...

#include <flow-monitor-helper.h>

Collaboration diagram for ns3::FlowMonitorHelper:

Public Member Functions
	FlowMonitorHelper ()
	~FlowMonitorHelper ()
Ptr< FlowClassifier >	GetClassifier ()
	Retrieve the FlowClassifier object created by the Install* methods. More...
Ptr< FlowMonitor >	GetMonitor ()
	Retrieve the FlowMonitor object created by the Install* methods. More...
Ptr< FlowMonitor >	Install (NodeContainer nodes)
	Enable flow monitoring on a set of nodes. More...
Ptr< FlowMonitor >	Install (Ptr< Node > node)
	Enable flow monitoring on a single node. More...
Ptr< FlowMonitor >	InstallAll ()
	Enable flow monitoring on all nodes. More...
void	SetMonitorAttribute (std::string n1, const AttributeValue &v1)
	Set an attribute for the to-be-created FlowMonitor object. More...

Private Attributes
Ptr< FlowClassifier >	m_flowClassifier
	the FlowClassifier object More...
Ptr< FlowMonitor >	m_flowMonitor
	the FlowMonitor object More...
ObjectFactory	m_monitorFactory
	Object factory. More...

Detailed Description

Helper to enable IPv4 flow monitoring on a set of Nodes.

Definition at line 38 of file flow-monitor-helper.h.

Constructor & Destructor Documentation

ns3::FlowMonitorHelper::FlowMonitorHelper

(

)

Definition at line 33 of file flow-monitor-helper.cc.

References m_monitorFactory, and ns3::ObjectFactory::SetTypeId().

Here is the call graph for this function:

ns3::FlowMonitorHelper::~FlowMonitorHelper

(

)

Definition at line 38 of file flow-monitor-helper.cc.

References m_flowClassifier, and m_flowMonitor.

Member Function Documentation

Ptr< FlowClassifier > ns3::FlowMonitorHelper::GetClassifier

(

)

Retrieve the FlowClassifier object created by the Install* methods.

Returns

a pointer to the FlowClassifier object

Definition at line 69 of file flow-monitor-helper.cc.

References m_flowClassifier.

Referenced by experiment(), and Install().

Here is the caller graph for this function:

Ptr< FlowMonitor > ns3::FlowMonitorHelper::GetMonitor

(

)

Retrieve the FlowMonitor object created by the Install* methods.

Returns

a pointer to the FlowMonitor object

Definition at line 56 of file flow-monitor-helper.cc.

References ns3::ObjectFactory::Create(), m_flowClassifier, m_flowMonitor, and m_monitorFactory.

Referenced by Install().

Here is the call graph for this function:

Here is the caller graph for this function:

Ptr< FlowMonitor > ns3::FlowMonitorHelper::Install

(

NodeContainer

nodes

)

Enable flow monitoring on a set of nodes.

Parameters

nodes

A NodeContainer holding the set of nodes to work with.

Returns

a pointer to the FlowMonitor object

Definition at line 92 of file flow-monitor-helper.cc.

References ns3::NodeContainer::Begin(), ns3::NodeContainer::End(), ns3::Object::GetObject(), and m_flowMonitor.

Referenced by InstallAll().

Here is the call graph for this function:

Here is the caller graph for this function:

Ptr< FlowMonitor > ns3::FlowMonitorHelper::Install

(

Ptr< Node >

node

)

Enable flow monitoring on a single node.

Parameters

node	A Ptr<Node> to the node on which to enable flow monitoring.

Returns

a pointer to the FlowMonitor object

Definition at line 80 of file flow-monitor-helper.cc.

References GetClassifier(), GetMonitor(), and m_flowMonitor.

Here is the call graph for this function:

Ptr< FlowMonitor > ns3::FlowMonitorHelper::InstallAll

(

void

)

Enable flow monitoring on all nodes.

Returns

a pointer to the FlowMonitor object

Definition at line 106 of file flow-monitor-helper.cc.

References ns3::NodeList::Begin(), ns3::NodeList::End(), ns3::Object::GetObject(), Install(), and m_flowMonitor.

Referenced by experiment(), main(), and Experiment::Run().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::FlowMonitorHelper::SetMonitorAttribute	(	std::string	n1,
		const AttributeValue &	v1
	)

Set an attribute for the to-be-created FlowMonitor object.

Parameters

n1	attribute name
v1	attibute value

Definition at line 49 of file flow-monitor-helper.cc.

References m_monitorFactory, and ns3::ObjectFactory::Set().

Here is the call graph for this function:

Member Data Documentation

Ptr<FlowClassifier> ns3::FlowMonitorHelper::m_flowClassifier

private

the FlowClassifier object

Definition at line 85 of file flow-monitor-helper.h.

Referenced by GetClassifier(), GetMonitor(), and ~FlowMonitorHelper().

Ptr<FlowMonitor> ns3::FlowMonitorHelper::m_flowMonitor

private

the FlowMonitor object

Definition at line 84 of file flow-monitor-helper.h.

Referenced by GetMonitor(), Install(), InstallAll(), and ~FlowMonitorHelper().

ObjectFactory ns3::FlowMonitorHelper::m_monitorFactory

private

Object factory.

Definition at line 83 of file flow-monitor-helper.h.

Referenced by FlowMonitorHelper(), GetMonitor(), and SetMonitorAttribute().

---

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

• src/flow-monitor/helper/flow-monitor-helper.h
• src/flow-monitor/helper/flow-monitor-helper.cc