ns3::OnOffHelper Class Reference

instanciate an ns3::OnOffApplication on a set of nodes. More...

#include <on-off-helper.h>

Collaboration diagram for ns3::OnOffHelper:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 OnOffHelper (std::string protocol, Address address)
void SetAttribute (std::string name, const AttributeValue &value)
ApplicationContainer Install (NodeContainer c) const
ApplicationContainer Install (Ptr< Node > node) const

Private Member Functions

Ptr< ApplicationInstallPriv (Ptr< Node > node) const

Private Attributes

std::string m_protocol
Address m_remote
ObjectFactory m_factory

Detailed Description

instanciate an ns3::OnOffApplication on a set of nodes.

Definition at line 37 of file on-off-helper.h.


Constructor & Destructor Documentation

ns3::OnOffHelper::OnOffHelper ( std::string  protocol,
Address  address 
)
Parameters:
protocol the name of the protocol to use to send traffic by the applications. This string identifies the socket factory type used to create sockets for the applications. A typical value would be ns3::UdpSocketFactory.
address the address of the remote node to send traffic to.

Definition at line 23 of file on-off-helper.cc.

References m_factory, ns3::ObjectFactory::Set(), and ns3::ObjectFactory::SetTypeId().


Member Function Documentation

ApplicationContainer ns3::OnOffHelper::Install ( Ptr< Node node  )  const

Install an ns3::OnOffApplication on the node configured with all the attributes set with SetAttribute.

Parameters:
node The node on which an OnOffApplication will be installed.
Returns:
Container of Ptr to the applications installed.

Definition at line 37 of file on-off-helper.cc.

ApplicationContainer ns3::OnOffHelper::Install ( NodeContainer  c  )  const

Install an ns3::OnOffApplication on each node of the input container configured with all the attributes set with SetAttribute.

Parameters:
c NodeContainer of the set of nodes on which an OnOffApplication will be installed.
Returns:
Container of Ptr to the applications installed.

Definition at line 43 of file on-off-helper.cc.

Ptr< Application > ns3::OnOffHelper::InstallPriv ( Ptr< Node node  )  const [private]

Install an ns3::OnOffApplication on the node configured with all the attributes set with SetAttribute.

Parameters:
node The node on which an OnOffApplication will be installed.
Returns:
Ptr to the application installed.

Definition at line 55 of file on-off-helper.cc.

void ns3::OnOffHelper::SetAttribute ( std::string  name,
const AttributeValue value 
)
Parameters:
name the name of the application attribute to set
value the value of the application attribute to set

Definition at line 31 of file on-off-helper.cc.


Member Data Documentation

Definition at line 86 of file on-off-helper.h.

Referenced by OnOffHelper().

std::string ns3::OnOffHelper::m_protocol [private]

Definition at line 84 of file on-off-helper.h.

Definition at line 85 of file on-off-helper.h.


The documentation for this class was generated from the following files:
Generated on Thu Dec 3 14:11:33 2009 for NS-3 by  doxygen 1.6.3