A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 ()
 Construct a FlowMonitorHelper class which makes it easier to configure and use the FlowMonitor.
Ptr< FlowClassifierGetClassifier ()
 Retrieve the FlowClassifier object created by the Install* methods.
Ptr< FlowMonitorGetMonitor ()
 Retrieve the FlowMonitor object created by the Install* methods.
Ptr< FlowMonitorInstall (NodeContainer nodes)
 Enable flow monitoring on a set of nodes.
Ptr< FlowMonitorInstall (Ptr< Node > node)
 Enable flow monitoring on a single node.
Ptr< FlowMonitorInstallAll ()
 Enable flow monitoring on all nodes.
void SetMonitorAttribute (std::string n1, const AttributeValue &v1)
 Set an attribute for the to-be-created FlowMonitor object.

Private Attributes

Ptr< FlowClassifierm_flowClassifier
Ptr< FlowMonitorm_flowMonitor
ObjectFactory m_monitorFactory

Detailed Description

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

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

Constructor & Destructor Documentation

ns3::FlowMonitorHelper::FlowMonitorHelper ( )

Construct a FlowMonitorHelper class which makes it easier to configure and use the FlowMonitor.

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:

Member Function Documentation

Ptr< FlowClassifier > ns3::FlowMonitorHelper::GetClassifier ( )

Retrieve the FlowClassifier object created by the Install* methods.

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

References m_flowClassifier.

Referenced by Install().

+ Here is the caller graph for this function:

Ptr< FlowMonitor > ns3::FlowMonitorHelper::GetMonitor ( )

Retrieve the FlowMonitor object created by the Install* methods.

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

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

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
nodesA NodeContainer holding the set of nodes to work with.

Definition at line 82 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
nodeA Ptr<Node> to the node on which to enable flow monitoring.

Definition at line 70 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.

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

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

Referenced by main().

+ 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.

Definition at line 39 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

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

Referenced by GetClassifier(), and GetMonitor().

Ptr<FlowMonitor> ns3::FlowMonitorHelper::m_flowMonitor
private

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

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

ObjectFactory ns3::FlowMonitorHelper::m_monitorFactory
private

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

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


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