use valueref where needed.
This commit is contained in:
@@ -50,7 +50,7 @@ public:
|
||||
|
||||
/**
|
||||
* \returns the default propagation loss model as specified
|
||||
* by the PropagationLossModelType ns3::DefaultValue.
|
||||
* by \valueref{PropagationLossModelType}.
|
||||
*/
|
||||
static Ptr<PropagationLossModel> CreateDefault (void);
|
||||
};
|
||||
@@ -62,7 +62,7 @@ class RandomPropagationLossModel : public PropagationLossModel
|
||||
{
|
||||
public:
|
||||
/**
|
||||
* Use the default parameters from RandomPropagation.
|
||||
* Use the default parameters from \valueref{RandomPropagationLossDistribution}.
|
||||
*/
|
||||
RandomPropagationLossModel ();
|
||||
/**
|
||||
@@ -88,7 +88,8 @@ class FriisPropagationLossModel : public PropagationLossModel
|
||||
{
|
||||
public:
|
||||
/**
|
||||
* Use the default parameters from \valueref{FriisPropagationLambda}.
|
||||
* Use the default parameters from \valueref{FriisPropagationLossLambda},
|
||||
* and \valueref{FriisPropagationLossSystemLoss}.
|
||||
*/
|
||||
FriisPropagationLossModel ();
|
||||
/**
|
||||
@@ -143,8 +144,8 @@ class PathLossPropagationLossModel : public PropagationLossModel
|
||||
public:
|
||||
/**
|
||||
* Use the default parameters from
|
||||
* PathLossPropagationExponent, and,
|
||||
* PathLossPropagationReferenceType
|
||||
* \valueref{PathLossPropagationLossExponent}, and,
|
||||
* \valueref{PathLossPropagationLossReferenceType}
|
||||
* to create a new propagation loss model.
|
||||
*/
|
||||
PathLossPropagationLossModel ();
|
||||
|
||||
@@ -41,7 +41,9 @@ class RandomDirection2dMobilityModelParameters : public Object
|
||||
{
|
||||
public:
|
||||
/**
|
||||
* Create a default parameter object from Bind default values.
|
||||
* Create from \valueref{RandomDirection2dSpeed},
|
||||
* \valueref{RandomDirection2dPause}, and,
|
||||
* \valueref{RandomDirection2dArea}.
|
||||
*/
|
||||
RandomDirection2dMobilityModelParameters ();
|
||||
/**
|
||||
@@ -91,7 +93,9 @@ class RandomDirection2dMobilityModel : public MobilityModel
|
||||
static const ClassId cid;
|
||||
|
||||
/**
|
||||
* Create a RandomDirection model from the default Bind values.
|
||||
* Create from \valueref{RandomDirection2dSpeed},
|
||||
* \valueref{RandomDirection2dPause}, and,
|
||||
* \valueref{RandomDirection2dArea}.
|
||||
*/
|
||||
RandomDirection2dMobilityModel ();
|
||||
/**
|
||||
|
||||
@@ -54,8 +54,9 @@ class RandomRectanglePosition : public RandomPosition
|
||||
public:
|
||||
static const ClassId cid;
|
||||
/**
|
||||
* Create a random position model based on the
|
||||
* Bind default values.
|
||||
* Create a random position model with construction
|
||||
* values from \valueref{RandomRectanglePositionX}, and
|
||||
* \valueref{RandomRectanglePositionY}
|
||||
*/
|
||||
RandomRectanglePosition ();
|
||||
/**
|
||||
@@ -82,8 +83,11 @@ class RandomDiscPosition : public RandomPosition
|
||||
public:
|
||||
static const ClassId cid;
|
||||
/**
|
||||
* Create a random position model based on the
|
||||
* Bind default values.
|
||||
* Create a random position model with construction
|
||||
* values from \valueref{RandomDiscPositionTheta},
|
||||
* \valueref{RandomDiscPositionRho},
|
||||
* \valueref{RandomDiscPositionX}, and,
|
||||
* \valueref{RandomDiscPositionY}.
|
||||
*/
|
||||
RandomDiscPosition ();
|
||||
/**
|
||||
|
||||
@@ -41,8 +41,9 @@ class RandomTopology
|
||||
{
|
||||
public:
|
||||
/**
|
||||
* Create a default random topology based
|
||||
* on Bind configuration.
|
||||
* Create a default random topology with construction
|
||||
* values from \valueref{RandomTopologyPositionType}, and,
|
||||
* \valueref{RandomTopologyMobilityType}.
|
||||
*/
|
||||
RandomTopology ();
|
||||
/**
|
||||
|
||||
@@ -44,7 +44,10 @@ class RandomWalk2dMobilityModelParameters : public Object
|
||||
public:
|
||||
/**
|
||||
* Instantiate a set of RandomWalk parameters initialized
|
||||
* with the Bind default values.
|
||||
* with construction values from \valueref{RandomWalk2dMode},
|
||||
* \valueref{RandomWalk2dDistance}, \valueref{RandomWalk2dTime},
|
||||
* \valueref{RandomWalk2dSpeed}, \valueref{RandomWalk2dDirection},
|
||||
* and, \valueref{RandomWalk2dBounds}.
|
||||
*/
|
||||
RandomWalk2dMobilityModelParameters ();
|
||||
virtual ~RandomWalk2dMobilityModelParameters ();
|
||||
@@ -115,7 +118,13 @@ class RandomWalk2dMobilityModel : public MobilityModel
|
||||
public:
|
||||
static const ClassId cid;
|
||||
/**
|
||||
* Create a new position object located at position (0,0,0)
|
||||
* Instantiate a set of RandomWalk parameters initialized
|
||||
* with construction values from \valueref{RandomWalk2dMode},
|
||||
* \valueref{RandomWalk2dDistance}, \valueref{RandomWalk2dTime},
|
||||
* \valueref{RandomWalk2dSpeed}, \valueref{RandomWalk2dDirection},
|
||||
* and, \valueref{RandomWalk2dBounds}.
|
||||
*
|
||||
* The default position is (0,0,0)
|
||||
*/
|
||||
RandomWalk2dMobilityModel ();
|
||||
/**
|
||||
|
||||
@@ -38,7 +38,8 @@ class RandomWaypointMobilityModelParameters : public Object
|
||||
{
|
||||
public:
|
||||
/**
|
||||
* Defaults parameters based on the Bind values.
|
||||
* Default parameters from \valueref{RandomWaypointPause},
|
||||
* and, \valueref{RandomWaypointPosition}.
|
||||
*/
|
||||
RandomWaypointMobilityModelParameters ();
|
||||
/**
|
||||
@@ -88,7 +89,8 @@ public:
|
||||
static const ClassId cid;
|
||||
|
||||
/**
|
||||
* Create a waypoint mobility model from the Bind default values.
|
||||
* Default parameters from \valueref{RandomWaypointPause},
|
||||
* and, \valueref{RandomWaypointPosition}.
|
||||
*/
|
||||
RandomWaypointMobilityModel ();
|
||||
/**
|
||||
|
||||
Reference in New Issue
Block a user