F5/unison
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doxygen.

Browse Source
This commit is contained in:
Mathieu Lacage
2008-03-24 11:49:58 -07:00
parent 41bbee50af
commit 47775d87da
2 changed files with 50 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/helper/csma-helper.h
View File

@@ -42,7 +42,7 @@ public:
* \param n1 the name of the attribute to set
* \param v1 the value of the attribute to set
*
* Set these parameters on each CsmaNetDevice created
* Set these parameters on each ns3::CsmaNetDevice created
* by CsmaHelper::Build
*/
void SetDeviceParameter (std::string n1, Attribute v1);
@@ -51,7 +51,7 @@ public:
* \param n1 the name of the attribute to set
* \param v1 the value of the attribute to set
*
* Set these parameters on each CsmaChannel created
* Set these parameters on each ns3::CsmaChannel created
* by CsmaHelper::Build
*/
void SetChannelParameter (std::string n1, Attribute v1);
@@ -69,7 +69,7 @@ public:
* \param c a set of nodes
* \param channel the channel to use as a backbone.
*
* For each node in the input container, we create a ns::CsmaNetDevice with
* For each node in the input container, we create a ns3::CsmaNetDevice with
* the requested parameters, a queue for this NetDevice, and associate
* the resulting ns3::NetDevice with the ns3::Node and ns3::CsmaChannel.
*/

47
src/helper/point-to-point-helper.h
View File

@@ -8,22 +8,69 @@
namespace ns3 {
/**
* \brief build a set of PointToPointNetDevice objects
*/
class PointToPointHelper
{
public:
// by default, create queues of type DropTailQueue.
PointToPointHelper ();
/**
* \param type the type of queue
* \param n1 the name of the attribute to set on the queue
* \param v1 the value of the attribute to set on the queue
* \param n2 the name of the attribute to set on the queue
* \param v2 the value of the attribute to set on the queue
* \param n3 the name of the attribute to set on the queue
* \param v3 the value of the attribute to set on the queue
* \param n4 the name of the attribute to set on the queue
* \param v4 the value of the attribute to set on the queue
*
* Set the type of queue to create and associated to each
* PointToPointNetDevice created through PointToPointHelper::Build.
*/
void SetQueue (std::string type,
std::string n1 = "", Attribute v1 = Attribute (),
std::string n2 = "", Attribute v2 = Attribute (),
std::string n3 = "", Attribute v3 = Attribute (),
std::string n4 = "", Attribute v4 = Attribute ());
/**
* \param n1 the name of the attribute to set
* \param v1 the value of the attribute to set
*
* Set these parameters on each ns3::PointToPointNetDevice created
* by PointToPointHelper::Build
*/
void SetDeviceParameter (std::string name, Attribute value);
/**
* \param n1 the name of the attribute to set
* \param v1 the value of the attribute to set
*
* Set these parameters on each ns3::PointToPointChannel created
* by PointToPointHelper::Build
*/
void SetChannelParameter (std::string name, Attribute value);
/**
* \param c a set of nodes
*
* This method creates a ns3::PointToPointChannel with the
* attributes configured by PointToPointHelper::SetChannelParameter,
* then, for each node in the input container, we create a
* ns3::PointToPointNetDevice with the requested parameters,
* a queue for this ns3::NetDevice, and associate the resulting
* ns3::NetDevice with the ns3::Node and ns3::PointToPointChannel.
*/
NetDeviceContainer Build (NodeContainer c);
/**
* \param a first node
* \param b second node
*
* Saves you from having to construct a temporary NodeContainer.
*/
NetDeviceContainer Build (Ptr<Node> a, Ptr<Node> b);
private: