ns3::OnOffHelper Class Reference
instanciate an ns3::OnOffApplication on a set of nodes. More...
#include <on-off-helper.h>
Collaboration diagram for ns3::OnOffHelper:
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 |
| ApplicationContainer | Install (std::string nodeName) const |
Private Member Functions | |
| Ptr< Application > | InstallPriv (Ptr< Node > node) const |
Detailed Description
instanciate an ns3::OnOffApplication on a set of nodes.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.
Member Function Documentation
| ApplicationContainer ns3::OnOffHelper::Install | ( | std::string | nodeName | ) | const |
Install an ns3::OnOffApplication on the node configured with all the attributes set with SetAttribute.
- Parameters:
-
nodeName The node on which an OnOffApplication will be installed.
- Returns:
- Container of Ptr to the applications installed.
| 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.
| 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.
| 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.
| 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
The documentation for this class was generated from the following file:
- src/helper/on-off-helper.h
