doxygen OnOffHelper.
authorMathieu Lacage <mathieu.lacage@sophia.inria.fr>
Tue Aug 26 11:17:31 2008 -0700 (17 months ago)
changeset 3577e24c4db6fd71
parent 3576 acd6d5b9c40d
child 3578 6c3efec9cbe6
doxygen OnOffHelper.
src/helper/on-off-helper.h
     1.1 --- a/src/helper/on-off-helper.h	Tue Aug 26 08:42:28 2008 -0700
     1.2 +++ b/src/helper/on-off-helper.h	Tue Aug 26 11:17:31 2008 -0700
     1.3 @@ -31,13 +31,34 @@
     1.4  
     1.5  namespace ns3 {
     1.6  
     1.7 +/**
     1.8 + * \brief instanciate an ns3::OnOffApplication on a set of nodes.
     1.9 + */
    1.10  class OnOffHelper
    1.11  {
    1.12  public:
    1.13 +  /**
    1.14 +   * \param protocol the name of the protocol to use to send traffic
    1.15 +   *        by the applications. This string identifies the socket
    1.16 +   *        factory type used to create sockets for the applications.
    1.17 +   *        A typical value would be ns3::UdpSocketFactory.
    1.18 +   * \param address the address of the remote node to send traffic
    1.19 +   *        to.
    1.20 +   */
    1.21    OnOffHelper (std::string protocol, Address address);
    1.22  
    1.23 +  /**
    1.24 +   * \param name the name of the application attribute to set
    1.25 +   * \param value the value of the application attribute to set
    1.26 +   */
    1.27    void SetAttribute (std::string name, const AttributeValue &value);
    1.28  
    1.29 +  /**
    1.30 +   * \param c the set of nodes on which an OnOffApplication will be installed.
    1.31 +   *
    1.32 +   * Install an ns3::OnOffApplication on each node of the input container
    1.33 +   * configured with all the attributes set with SetAttribute.
    1.34 +   */
    1.35    ApplicationContainer Install (NodeContainer c);
    1.36  
    1.37  private: