wave: doxygen wave group added
This commit is contained in:
@@ -33,6 +33,7 @@ class WaveNetDevice;
|
||||
class Node;
|
||||
|
||||
/**
|
||||
* \ingroup wave
|
||||
* To trace WaveNetDevice, we have to overwrite the trace functions of class YansWifiPhyHelper.
|
||||
* The source code is very similar with YansWifiPhy, only with some adaptation.
|
||||
*/
|
||||
@@ -80,6 +81,7 @@ private:
|
||||
};
|
||||
|
||||
/**
|
||||
* \ingroup wave
|
||||
* \brief helps to create WaveNetDevice objects
|
||||
*
|
||||
* This class can help to create a large set of similar
|
||||
|
||||
@@ -28,6 +28,7 @@
|
||||
namespace ns3 {
|
||||
|
||||
/**
|
||||
* \ingroup wave
|
||||
* \brief helps to create wifi 802.11p objects of
|
||||
* WifiNetDevice class
|
||||
*
|
||||
|
||||
@@ -24,6 +24,7 @@
|
||||
namespace ns3 {
|
||||
|
||||
/**
|
||||
* \ingroup wave
|
||||
* \brief receive notifications about channel coordination events.
|
||||
*/
|
||||
class ChannelCoordinationListener : public SimpleRefCount<ChannelCoordinationListener>
|
||||
|
||||
@@ -26,6 +26,8 @@
|
||||
namespace ns3 {
|
||||
|
||||
/**
|
||||
* \ingroup wave
|
||||
*
|
||||
* WAVE channels
|
||||
* channel number | 172 | 174 | 176 | 178 | 180 | 182 | 184 |
|
||||
* channel bandwidth 10MHz 10MHz 10MHz 10MHz 10MHz 10MHz 10MHz
|
||||
|
||||
@@ -23,21 +23,34 @@
|
||||
namespace ns3 {
|
||||
class WaveNetDevice;
|
||||
|
||||
/// EdcaParameter structure
|
||||
/**
|
||||
* \ingroup wave
|
||||
* EdcaParameter structure
|
||||
*/
|
||||
struct EdcaParameter
|
||||
{
|
||||
uint32_t cwmin; ///< minimum
|
||||
uint32_t cwmax; ///< maximum
|
||||
uint32_t aifsn; ///< AIFSN
|
||||
};
|
||||
/// EDCA parameters typedef
|
||||
|
||||
/**
|
||||
* \ingroup wave
|
||||
* EDCA parameters typedef
|
||||
*/
|
||||
typedef std::map<AcIndex,EdcaParameter> EdcaParameters;
|
||||
/// EDCA parameters iterator typedef
|
||||
|
||||
/**
|
||||
* \ingroup wave
|
||||
* EDCA parameters iterator typedef
|
||||
*/
|
||||
typedef std::map<AcIndex,EdcaParameter>::const_iterator EdcaParametersI;
|
||||
|
||||
#define EXTENDED_ALTERNATING 0x00
|
||||
#define EXTENDED_CONTINUOUS 0xff
|
||||
/**
|
||||
* \ingroup wave
|
||||
*
|
||||
* \param channelNumber channel number that the SCH service
|
||||
* can be made available for communications.
|
||||
* \param operationalRateSet OperationalRateSet if present, as specified in IEEE Std 802.11.
|
||||
|
||||
@@ -32,6 +32,8 @@ class TypeId;
|
||||
|
||||
/**
|
||||
* \ingroup packet
|
||||
* \ingroup wave
|
||||
*
|
||||
* \brief This tag will be used to support higher layer control DataRate
|
||||
* and TxPwr_Level for transmission.
|
||||
* If the high layer enables adaptable mode, DataRate will be the
|
||||
|
||||
@@ -33,9 +33,10 @@ namespace ns3 {
|
||||
class VendorSpecificContentManager;
|
||||
|
||||
/**
|
||||
* \ingroup wave
|
||||
*
|
||||
* \brief the organization identifier is a public organizationally
|
||||
* unique identifier assigned by the IEEE.
|
||||
* \ingroup wave
|
||||
*
|
||||
* Similar to protocol field of data packets that indicates which
|
||||
* entity of higher layer should handle received packets, Organization
|
||||
@@ -196,6 +197,8 @@ private:
|
||||
typedef Callback<bool, Ptr<WifiMac>, const OrganizationIdentifier &, Ptr<const Packet>,const Address &> VscCallback;
|
||||
|
||||
/**
|
||||
* \ingroup wave
|
||||
*
|
||||
* VendorSpecificContentManager class
|
||||
*/
|
||||
class VendorSpecificContentManager
|
||||
|
||||
@@ -24,6 +24,8 @@
|
||||
namespace ns3 {
|
||||
|
||||
/**
|
||||
* \ingroup wave
|
||||
*
|
||||
* \brief indicate which interval the VSA frames will be transmitted in.
|
||||
* VSA_TRANSMIT_IN_CCHI will only allow in CCH Interval;
|
||||
* VSA_TRANSMIT_IN_SCHI will only allow in SCH Interval;
|
||||
@@ -37,6 +39,8 @@ enum VsaTransmitInterval
|
||||
};
|
||||
|
||||
/**
|
||||
* \ingroup wave
|
||||
*
|
||||
* \param peer The address of the peer MAC entity to which the
|
||||
* VSA is sent.
|
||||
* \param oi Identifies the source of the data when the source
|
||||
@@ -90,6 +94,8 @@ struct VsaInfo
|
||||
};
|
||||
|
||||
/**
|
||||
* \ingroup wave
|
||||
*
|
||||
* refer to 1609.4-2010 chapter 6.4
|
||||
* Vendor Specific Action (VSA) frames transmission.
|
||||
*
|
||||
|
||||
@@ -41,6 +41,13 @@ class VsaManager;
|
||||
class OcbWifiMac;
|
||||
|
||||
/**
|
||||
* \defgroup wave WAVE module
|
||||
*/
|
||||
|
||||
|
||||
/**
|
||||
* \ingroup wave
|
||||
*
|
||||
* \param channelNumber the specific channel
|
||||
* \param priority the priority of packet with range 0-7
|
||||
* \param dataRate the transmit data rate of packet
|
||||
@@ -89,6 +96,8 @@ struct TxInfo
|
||||
};
|
||||
|
||||
/**
|
||||
* \ingroup wave
|
||||
*
|
||||
* \param channelNumber the channel number for the SCH.
|
||||
* \param adaptable if true, the actual power level and data
|
||||
* rate for transmission are adaptable. TxPwr_Level is the maximum
|
||||
@@ -133,6 +142,8 @@ struct TxProfile
|
||||
};
|
||||
|
||||
/**
|
||||
* \ingroup wave
|
||||
*
|
||||
* This class holds together multiple, ns3::WifiPhy,
|
||||
* and ns3::OcbWifiMac (including ns3::WifiRemoteStationManager).
|
||||
* Besides that, to support multiple channel operation this
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
using namespace ns3;
|
||||
|
||||
/**
|
||||
* \ingroup wave-test
|
||||
* \ingroup wave
|
||||
* \defgroup wave-test wave module tests
|
||||
*/
|
||||
|
||||
|
||||
Reference in New Issue
Block a user