1.1 --- a/src/devices/wifi/adhoc-wifi-mac.cc Wed Jun 04 14:02:06 2008 +0100
1.2 +++ b/src/devices/wifi/adhoc-wifi-mac.cc Wed Jun 04 09:18:44 2008 -0700
1.3 @@ -137,9 +137,7 @@
1.4 }
1.5 void
1.6 AdhocWifiMac::SetLinkDownCallback (Callback<void> linkDown)
1.7 -{
1.8 - //XXX
1.9 -}
1.10 +{}
1.11 Mac48Address
1.12 AdhocWifiMac::GetAddress (void) const
1.13 {
2.1 --- a/src/devices/wifi/dca-txop.cc Wed Jun 04 14:02:06 2008 +0100
2.2 +++ b/src/devices/wifi/dca-txop.cc Wed Jun 04 09:18:44 2008 -0700
2.3 @@ -99,17 +99,17 @@
2.4 static TypeId tid = TypeId ("DcaTxop")
2.5 .SetParent<Object> ()
2.6 .AddConstructor<DcaTxop> ()
2.7 - .AddAttribute ("MinCw", "XXX",
2.8 + .AddAttribute ("MinCw", "The minimum value of the contention window.",
2.9 UintegerValue (15),
2.10 MakeUintegerAccessor (&DcaTxop::SetMinCw,
2.11 &DcaTxop::GetMinCw),
2.12 MakeUintegerChecker<uint32_t> ())
2.13 - .AddAttribute ("MaxCw", "XXX",
2.14 + .AddAttribute ("MaxCw", "The maximum value of the contention window.",
2.15 UintegerValue (1023),
2.16 MakeUintegerAccessor (&DcaTxop::SetMaxCw,
2.17 &DcaTxop::GetMaxCw),
2.18 MakeUintegerChecker<uint32_t> ())
2.19 - .AddAttribute ("Aifsn", "XXX",
2.20 + .AddAttribute ("Aifsn", "The AIFSN: the default value conforms to simple DCA.",
2.21 UintegerValue (2),
2.22 MakeUintegerAccessor (&DcaTxop::SetAifsn,
2.23 &DcaTxop::GetAifsn),
3.1 --- a/src/devices/wifi/nqsta-wifi-mac.cc Wed Jun 04 14:02:06 2008 +0100
3.2 +++ b/src/devices/wifi/nqsta-wifi-mac.cc Wed Jun 04 09:18:44 2008 -0700
3.3 @@ -62,11 +62,11 @@
3.4 static TypeId tid = TypeId ("ns3::NqstaWifiMac")
3.5 .SetParent<WifiMac> ()
3.6 .AddConstructor<NqstaWifiMac> ()
3.7 - .AddAttribute ("ProbeRequestTimeout", "XXX",
3.8 + .AddAttribute ("ProbeRequestTimeout", "The interval between two consecutive probe request attempts.",
3.9 TimeValue (Seconds (0.05)),
3.10 MakeTimeAccessor (&NqstaWifiMac::m_probeRequestTimeout),
3.11 MakeTimeChecker ())
3.12 - .AddAttribute ("AssocRequestTimeout", "XXX",
3.13 + .AddAttribute ("AssocRequestTimeout", "The interval between two consecutive assoc request attempts.",
3.14 TimeValue (Seconds (0.5)),
3.15 MakeTimeAccessor (&NqstaWifiMac::m_assocRequestTimeout),
3.16 MakeTimeChecker ())
3.17 @@ -76,7 +76,7 @@
3.18 UintegerValue (10),
3.19 MakeUintegerAccessor (&NqstaWifiMac::m_maxMissedBeacons),
3.20 MakeUintegerChecker<uint32_t> ())
3.21 - .AddAttribute ("ActiveProbing", "XXX",
3.22 + .AddAttribute ("ActiveProbing", "If true, we send probe requests. If false, we don't.",
3.23 BooleanValue (false),
3.24 MakeBooleanAccessor (&NqstaWifiMac::SetActiveProbing),
3.25 MakeBooleanChecker ())
4.1 --- a/src/devices/wifi/onoe-wifi-manager.cc Wed Jun 04 14:02:06 2008 +0100
4.2 +++ b/src/devices/wifi/onoe-wifi-manager.cc Wed Jun 04 09:18:44 2008 -0700
4.3 @@ -40,7 +40,7 @@
4.4 TimeValue (Seconds (1.0)),
4.5 MakeTimeAccessor (&OnoeWifiManager::m_updatePeriod),
4.6 MakeTimeChecker ())
4.7 - .AddAttribute ("RaiseThreshold", "XXX",
4.8 + .AddAttribute ("RaiseThreshold", "Attempt to raise the rate if we hit that threshold",
4.9 UintegerValue (10),
4.10 MakeUintegerAccessor (&OnoeWifiManager::m_raiseThreshold),
4.11 MakeUintegerChecker<uint32_t> ())
5.1 --- a/src/devices/wifi/propagation-loss-model.cc Wed Jun 04 14:02:06 2008 +0100
5.2 +++ b/src/devices/wifi/propagation-loss-model.cc Wed Jun 04 09:18:44 2008 -0700
5.3 @@ -55,7 +55,7 @@
5.4 static TypeId tid = TypeId ("ns3::RandomPropagationLossModel")
5.5 .SetParent<PropagationLossModel> ()
5.6 .AddConstructor<RandomPropagationLossModel> ()
5.7 - .AddAttribute ("Variable", "XXX",
5.8 + .AddAttribute ("Variable", "The random variable used to pick a loss everytime GetLoss is invoked.",
5.9 RandomVariableValue (ConstantVariable (1.0)),
5.10 MakeRandomVariableAccessor (&RandomPropagationLossModel::m_variable),
5.11 MakeRandomVariableChecker ())
6.1 --- a/src/devices/wifi/wifi-channel.cc Wed Jun 04 14:02:06 2008 +0100
6.2 +++ b/src/devices/wifi/wifi-channel.cc Wed Jun 04 09:18:44 2008 -0700
6.3 @@ -38,11 +38,11 @@
6.4 static TypeId tid = TypeId ("ns3::WifiChannel")
6.5 .SetParent<Channel> ()
6.6 .AddConstructor<WifiChannel> ()
6.7 - .AddAttribute ("PropagationLossModel", "XXX",
6.8 + .AddAttribute ("PropagationLossModel", "A pointer to the propagation loss model attached to this channel.",
6.9 PointerValue (),
6.10 MakePointerAccessor (&WifiChannel::m_loss),
6.11 MakePointerChecker<PropagationLossModel> ())
6.12 - .AddAttribute ("PropagationDelayModel", "XXX",
6.13 + .AddAttribute ("PropagationDelayModel", "A pointer to the propagation delay model attached to this channel.",
6.14 PointerValue (),
6.15 MakePointerAccessor (&WifiChannel::m_delay),
6.16 MakePointerChecker<PropagationDelayModel> ())
7.1 --- a/src/devices/wifi/wifi-mac.cc Wed Jun 04 14:02:06 2008 +0100
7.2 +++ b/src/devices/wifi/wifi-mac.cc Wed Jun 04 09:18:44 2008 -0700
7.3 @@ -73,42 +73,43 @@
7.4 {
7.5 static TypeId tid = TypeId ("ns3::WifiMac")
7.6 .SetParent<Object> ()
7.7 - .AddAttribute ("CtsTimeout", "XXX",
7.8 + .AddAttribute ("CtsTimeout", "When this timeout expires, the RTS/CTS handshake has failed.",
7.9 TimeValue (GetDefaultCtsAckTimeout ()),
7.10 MakeTimeAccessor (&WifiMac::m_ctsTimeout),
7.11 MakeTimeChecker ())
7.12 - .AddAttribute ("AckTimeout", "XXX",
7.13 + .AddAttribute ("AckTimeout", "When this timeout expires, the DATA/ACK handshake has failed.",
7.14 TimeValue (GetDefaultCtsAckTimeout ()),
7.15 MakeTimeAccessor (&WifiMac::m_ackTimeout),
7.16 MakeTimeChecker ())
7.17 - .AddAttribute ("Sifs", "XXX",
7.18 + .AddAttribute ("Sifs", "The value of the SIFS constant.",
7.19 TimeValue (GetDefaultSifs ()),
7.20 MakeTimeAccessor (&WifiMac::SetSifs,
7.21 &WifiMac::GetSifs),
7.22 MakeTimeChecker ())
7.23 - .AddAttribute ("EifsNoDifs", "XXX",
7.24 + .AddAttribute ("EifsNoDifs", "The value of EIFS-DIFS",
7.25 TimeValue (GetDefaultEifsNoDifs ()),
7.26 MakeTimeAccessor (&WifiMac::SetEifsNoDifs,
7.27 &WifiMac::GetEifsNoDifs),
7.28 MakeTimeChecker ())
7.29 - .AddAttribute ("Slot", "XXX",
7.30 + .AddAttribute ("Slot", "The duration of a Slot.",
7.31 TimeValue (GetDefaultSlot ()),
7.32 MakeTimeAccessor (&WifiMac::SetSlot,
7.33 &WifiMac::GetSlot),
7.34 MakeTimeChecker ())
7.35 - .AddAttribute ("Pifs", "XXX",
7.36 + .AddAttribute ("Pifs", "The value of the PIFS constant.",
7.37 TimeValue (GetDefaultSifs () + GetDefaultSlot ()),
7.38 MakeTimeAccessor (&WifiMac::m_pifs),
7.39 MakeTimeChecker ())
7.40 - .AddAttribute ("MaxPropagationDelay", "XXX",
7.41 + .AddAttribute ("MaxPropagationDelay", "The maximum propagation delay. Unused for now.",
7.42 TimeValue (GetDefaultMaxPropagationDelay ()),
7.43 MakeTimeAccessor (&WifiMac::m_maxPropagationDelay),
7.44 MakeTimeChecker ())
7.45 - .AddAttribute ("MaxMsduSize", "XXX",
7.46 + .AddAttribute ("MaxMsduSize", "The maximum size of an MSDU accepted by the MAC layer."
7.47 + "This value conforms to the specification.",
7.48 UintegerValue (2304),
7.49 MakeUintegerAccessor (&WifiMac::m_maxMsduSize),
7.50 MakeUintegerChecker<uint16_t> (1,2304))
7.51 - .AddAttribute ("Ssid", "XXX",
7.52 + .AddAttribute ("Ssid", "The ssid we want to belong to.",
7.53 SsidValue (Ssid ("default")),
7.54 MakeSsidAccessor (&WifiMac::GetSsid,
7.55 &WifiMac::SetSsid),
8.1 --- a/src/devices/wifi/wifi-mac.h Wed Jun 04 14:02:06 2008 +0100
8.2 +++ b/src/devices/wifi/wifi-mac.h Wed Jun 04 09:18:44 2008 -0700
8.3 @@ -70,13 +70,9 @@
8.4 */
8.5 void SetAckTimeout (Time ackTimeout);
8.6 /**
8.7 - * \param msduLifetime
8.8 + * \param delay the max propagation delay.
8.9 *
8.10 - * XXX: I cannot remmeber what this is used for.
8.11 - */
8.12 - void SetMsduLifetime (Time msduLifetime);
8.13 - /**
8.14 - * XXX: I cannot remember what this is used for.
8.15 + * Unused for now.
8.16 */
8.17 void SetMaxPropagationDelay (Time delay);
8.18
8.19 @@ -105,11 +101,11 @@
8.20 */
8.21 Time GetAckTimeout (void) const;
8.22 /**
8.23 - * XXX: I cannot remember what this is used for.
8.24 + * Unused for now.
8.25 */
8.26 Time GetMsduLifetime (void) const;
8.27 /**
8.28 - * XXX: I cannot remember what this is used for.
8.29 + * Unused for now.
8.30 */
8.31 Time GetMaxPropagationDelay (void) const;
8.32 /**
9.1 --- a/src/devices/wifi/wifi-phy.cc Wed Jun 04 14:02:06 2008 +0100
9.2 +++ b/src/devices/wifi/wifi-phy.cc Wed Jun 04 09:18:44 2008 -0700
9.3 @@ -227,7 +227,8 @@
9.4 MakeDoubleAccessor (&WifiPhy::SetRxNoise,
9.5 &WifiPhy::GetRxNoise),
9.6 MakeDoubleChecker<double> ())
9.7 - .AddAttribute ("Standard", "XXX",
9.8 + .AddAttribute ("Standard", "The standard chosen configures a set of transmission modes"
9.9 + " and some PHY-specific constants.",
9.10 EnumValue (WIFI_PHY_STANDARD_80211a),
9.11 MakeEnumAccessor (&WifiPhy::SetStandard),
9.12 MakeEnumChecker (WIFI_PHY_STANDARD_80211a, "802.11a",
9.13 @@ -712,7 +713,9 @@
9.14 return "SYNC";
9.15 break;
9.16 default:
9.17 - return "XXX";
9.18 + NS_ASSERT (false);
9.19 + // quiet compiler
9.20 + return "INVALID";
9.21 break;
9.22 }
9.23 }
10.1 --- a/src/devices/wifi/wifi-remote-station-manager.cc Wed Jun 04 14:02:06 2008 +0100
10.2 +++ b/src/devices/wifi/wifi-remote-station-manager.cc Wed Jun 04 09:18:44 2008 -0700
10.3 @@ -126,23 +126,32 @@
10.4 {
10.5 static TypeId tid = TypeId ("ns3::WifiRemoteStationManager")
10.6 .SetParent<Object> ()
10.7 - .AddAttribute ("IsLowLatency", "XXX",
10.8 + .AddAttribute ("IsLowLatency", "If true, we attempt to modelize a so-called low-latency device: a device"
10.9 + " where decisions about tx parameters can be made on a per-packet basis and feedback about the"
10.10 + " transmission of each packet is obtained before sending the next. Otherwise, we modelize a "
10.11 + " high-latency device, that is a device where we cannot update our decision about tx parameters"
10.12 + " after every packet transmission.",
10.13 BooleanValue (true),
10.14 MakeBooleanAccessor (&WifiRemoteStationManager::m_isLowLatency),
10.15 MakeBooleanChecker ())
10.16 - .AddAttribute ("MaxSsrc", "XXX",
10.17 + .AddAttribute ("MaxSsrc", "The maximum number of retransmission attempts for an RTS. This value"
10.18 + " will not have any effect on some rate control algorithms.",
10.19 UintegerValue (7),
10.20 MakeUintegerAccessor (&WifiRemoteStationManager::m_maxSsrc),
10.21 MakeUintegerChecker<uint32_t> ())
10.22 - .AddAttribute ("MaxSlrc", "XXX",
10.23 + .AddAttribute ("MaxSlrc", "The maximum number of retransmission attempts for a DATA packet. This value"
10.24 + " will not have any effect on some rate control algorithms.",
10.25 UintegerValue (7),
10.26 MakeUintegerAccessor (&WifiRemoteStationManager::m_maxSlrc),
10.27 MakeUintegerChecker<uint32_t> ())
10.28 - .AddAttribute ("RtsCtsThreshold", "XXX",
10.29 + .AddAttribute ("RtsCtsThreshold", "If a data packet is bigger than this value, we use an RTS/CTS handshake"
10.30 + " before sending the data. This value will not have any effect on some rate control algorithms.",
10.31 UintegerValue (1500),
10.32 MakeUintegerAccessor (&WifiRemoteStationManager::m_rtsCtsThreshold),
10.33 MakeUintegerChecker<uint32_t> ())
10.34 - .AddAttribute ("FragmentationThreshold", "XXX",
10.35 + .AddAttribute ("FragmentationThreshold", "If a data packet is bigger than this value, we fragment it such that"
10.36 + " the size of the fragments are equal or smaller than this value. This value will not have any effect"
10.37 + " on some rate control algorithms.",
10.38 UintegerValue (1500),
10.39 MakeUintegerAccessor (&WifiRemoteStationManager::m_fragmentationThreshold),
10.40 MakeUintegerChecker<uint32_t> ())
10.41 @@ -402,9 +411,9 @@
10.42 {
10.43 static TypeId tid = TypeId ("ns3::WifiRemoteStation")
10.44 .SetParent<Object> ()
10.45 - .AddTraceSource ("Ssrc", "XXX",
10.46 + .AddTraceSource ("Ssrc", "The value of the ssrc counter: indicates the number of retransmissions of RTS.",
10.47 MakeTraceSourceAccessor (&WifiRemoteStation::m_ssrc))
10.48 - .AddTraceSource ("Slrc", "XXX",
10.49 + .AddTraceSource ("Slrc", "The value of the slrc counter: indicates the number of retransmissions of DATA.",
10.50 MakeTraceSourceAccessor (&WifiRemoteStation::m_slrc))
10.51 ;
10.52 return tid;