Label deprecations with uncertain version tags, for later removal

This commit is contained in:
Peter D. Barnes, Jr
2024-10-04 10:40:45 -10:00
committed by Peter D. Barnes, Jr.
parent 756d741f7e
commit efff75fe4f
12 changed files with 34 additions and 2 deletions

View File

@@ -245,6 +245,7 @@ class Ipv4L3Protocol : public Ipv4
* \deprecated The non-const \c Ptr<Ipv4> argument is deprecated
* and will be changed to \c Ptr<const Ipv4> in a future release.
*/
// NS_DEPRECATED() - tag for future removal
typedef void (*TxRxTracedCallback)(Ptr<const Packet> packet,
Ptr<Ipv4> ipv4,
uint32_t interface);
@@ -260,6 +261,7 @@ class Ipv4L3Protocol : public Ipv4
* \deprecated The non-const \c Ptr<Ipv4> argument is deprecated
* and will be changed to \c Ptr<const Ipv4> in a future release.
*/
// NS_DEPRECATED() - tag for future removal
typedef void (*DropTracedCallback)(const Ipv4Header& header,
Ptr<const Packet> packet,
DropReason reason,
@@ -479,15 +481,18 @@ class Ipv4L3Protocol : public Ipv4
/// Trace of transmitted packets
/// \deprecated The non-const \c Ptr<Ipv4> argument is deprecated
/// and will be changed to \c Ptr<const Ipv4> in a future release.
// NS_DEPRECATED() - tag for future removal
TracedCallback<Ptr<const Packet>, Ptr<Ipv4>, uint32_t> m_txTrace;
/// Trace of received packets
/// \deprecated The non-const \c Ptr<Ipv4> argument is deprecated
/// and will be changed to \c Ptr<const Ipv4> in a future release.
// NS_DEPRECATED() - tag for future removal
TracedCallback<Ptr<const Packet>, Ptr<Ipv4>, uint32_t> m_rxTrace;
// <ip-header, payload, reason, ifindex> (ifindex not valid if reason is DROP_NO_ROUTE)
/// Trace of dropped packets
/// \deprecated The non-const \c Ptr<Ipv4> argument is deprecated
/// and will be changed to \c Ptr<const Ipv4> in a future release.
// NS_DEPRECATED() - tag for future removal
TracedCallback<const Ipv4Header&, Ptr<const Packet>, DropReason, Ptr<Ipv4>, uint32_t>
m_dropTrace;

View File

@@ -394,6 +394,7 @@ class Ipv6L3Protocol : public Ipv6
* \deprecated The non-const \c Ptr<Ipv6> argument is deprecated
* and will be changed to \c Ptr<const Ipv6> in a future release.
*/
// NS_DEPRECATED() - tag for future removal
typedef void (*TxRxTracedCallback)(Ptr<const Packet> packet,
Ptr<Ipv6> ipv6,
uint32_t interface);
@@ -409,6 +410,7 @@ class Ipv6L3Protocol : public Ipv6
* \deprecated The non-const \c Ptr<Ipv6> argument is deprecated
* and will be changed to \c Ptr<const Ipv6> in a future release.
*/
// NS_DEPRECATED() - tag for future removal
typedef void (*DropTracedCallback)(const Ipv6Header& header,
Ptr<const Packet> packet,
DropReason reason,
@@ -557,6 +559,7 @@ class Ipv6L3Protocol : public Ipv6
* \deprecated The non-const \c Ptr<Ipv6> argument is deprecated
* and will be changed to \c Ptr<const Ipv6> in a future release.
*/
// NS_DEPRECATED() - tag for future removal
TracedCallback<Ptr<const Packet>, Ptr<Ipv6>, uint32_t> m_txTrace;
/**
@@ -564,6 +567,7 @@ class Ipv6L3Protocol : public Ipv6
* \deprecated The non-const \c Ptr<Ipv6> argument is deprecated
* and will be changed to \c Ptr<const Ipv6> in a future release.
*/
// NS_DEPRECATED() - tag for future removal
TracedCallback<Ptr<const Packet>, Ptr<Ipv6>, uint32_t> m_rxTrace;
/**
@@ -571,6 +575,7 @@ class Ipv6L3Protocol : public Ipv6
* \deprecated The non-const \c Ptr<Ipv6> argument is deprecated
* and will be changed to \c Ptr<const Ipv6> in a future release.
*/
// NS_DEPRECATED() - tag for future removal
TracedCallback<const Ipv6Header&, Ptr<const Packet>, DropReason, Ptr<Ipv6>, uint32_t>
m_dropTrace;

View File

@@ -728,6 +728,7 @@ class LrWpanMac : public LrWpanMacBase
* TracedValue \c MacStateValue. The \c MacState TracedCallback will
* be removed in a future release.
*/
// NS_DEPRECATED() - tag for future removal
typedef void (*StateTracedCallback)(MacState oldState, MacState newState);
protected:
@@ -1127,6 +1128,7 @@ class LrWpanMac : public LrWpanMacBase
* removed in a future release, Instead, use the \c MacStateValue
* TracedValue.
*/
// NS_DEPRECATED() - tag for future removal
TracedCallback<MacState, MacState> m_macStateLogger;
/**

View File

@@ -556,6 +556,7 @@ class LrWpanPhy : public SpectrumPhy
* TracedValue \c TrxStateValue. The \c TrxState TracedCallback will
* be removed in a future release.
*/
// NS_DEPRECATED() - tag for future removal
typedef void (*StateTracedCallback)(Time time,
PhyEnumeration oldState,
PhyEnumeration newState);
@@ -738,6 +739,7 @@ class LrWpanPhy : public SpectrumPhy
* TracedValue \c TrxStateValue. This TracedCallback will
* be removed in a future release.
*/
// NS_DEPRECATED() - tag for future removal
TracedCallback<Time, PhyEnumeration, PhyEnumeration> m_trxStateLogger;
/**

View File

@@ -303,6 +303,7 @@ class LteEnbPhy : public LtePhy
* \deprecated The non-const \c Ptr<SpectrumValue> argument is deprecated
* and will be changed to \c Ptr<const SpectrumValue> in a future release.
*/
// NS_DEPRECATED() - tag for future removal
typedef void (*ReportInterferenceTracedCallback)(uint16_t cellId,
Ptr<SpectrumValue> spectrumValue);
@@ -486,6 +487,7 @@ class LteEnbPhy : public LtePhy
* \deprecated The non-const \c Ptr<SpectrumValue> argument is deprecated
* and will be changed to \c Ptr<const SpectrumValue> in a future release.
*/
// NS_DEPRECATED() - tag for future removal
TracedCallback<uint16_t, Ptr<SpectrumValue>> m_reportInterferenceTrace;
/**
* The `InterferenceSamplePeriod` attribute. The sampling period for

View File

@@ -130,6 +130,7 @@ class PointToPointChannel : public Channel
* \deprecated The non-const \c Ptr<NetDevice> argument is deprecated
* and will be changed to \c Ptr<const NetDevice> in a future release.
*/
// NS_DEPRECATED() - tag for future removal
typedef void (*TxRxAnimationCallback)(Ptr<const Packet> packet,
Ptr<NetDevice> txDevice,
Ptr<NetDevice> rxDevice,
@@ -154,6 +155,7 @@ class PointToPointChannel : public Channel
* \deprecated The non-const \c Ptr<NetDevice> argument is deprecated
* and will be changed to \c Ptr<const NetDevice> in a future release.
*/
// NS_DEPRECATED() - tag for future removal
TracedCallback<Ptr<const Packet>, // Packet being transmitted
Ptr<NetDevice>, // Transmitting NetDevice
Ptr<NetDevice>, // Receiving NetDevice

View File

@@ -167,6 +167,7 @@ class SixLowPanNetDevice : public NetDevice
* is deprecated and will be changed to \c Ptr<const SixLowPanNetDevice>
* in a future release.
*/
// NS_DEPRECATED() - tag for future removal
typedef void (*RxTxTracedCallback)(Ptr<const Packet> packet,
Ptr<SixLowPanNetDevice> sixNetDevice,
uint32_t ifindex);
@@ -182,6 +183,7 @@ class SixLowPanNetDevice : public NetDevice
* is deprecated and will be changed to \c Ptr<const SixLowPanNetDevice>
* in a future release.
*/
// NS_DEPRECATED() - tag for future removal
typedef void (*DropTracedCallback)(DropReason reason,
Ptr<const Packet> packet,
Ptr<SixLowPanNetDevice> sixNetDevice,
@@ -309,6 +311,7 @@ class SixLowPanNetDevice : public NetDevice
* is deprecated and will be changed to \c Ptr<const SixLowPanNetDevice>
* in a future release.
*/
// NS_DEPRECATED() - tag for future removal
TracedCallback<Ptr<const Packet>, Ptr<SixLowPanNetDevice>, uint32_t> m_txTrace;
/**
@@ -322,6 +325,7 @@ class SixLowPanNetDevice : public NetDevice
* is deprecated and will be changed to \c Ptr<const SixLowPanNetDevice>
* in a future release.
*/
// NS_DEPRECATED() - tag for future removal
TracedCallback<Ptr<const Packet>, Ptr<SixLowPanNetDevice>, uint32_t> m_rxTrace;
/**
@@ -336,6 +340,7 @@ class SixLowPanNetDevice : public NetDevice
* is deprecated and will be changed to \c Ptr<const SixLowPanNetDevice>
* in a future release.
*/
// NS_DEPRECATED() - tag for future removal
TracedCallback<DropReason, Ptr<const Packet>, Ptr<SixLowPanNetDevice>, uint32_t> m_dropTrace;
/**

View File

@@ -558,6 +558,7 @@ class SpectrumValue : public SimpleRefCount<SpectrumValue>
* is deprecated and will be changed to \c Ptr<const SpectrumPhy>
* in a future release.
*/
// NS_DEPRECATED() - tag for future removal
typedef void (*TracedCallback)(Ptr<SpectrumValue> value);
private:

View File

@@ -240,8 +240,6 @@ class ThreeGppChannelModel : public MatrixBasedChannelModel
* \param hUT the height of the UT
* \param distance2D the 2D distance between tx and rx
* \return the parameters table
* \deprecated Use GetThreeGppTable(const Ptr<const MobilityModel> aMob, const Ptr<const
* MobilityModel> bMob, Ptr<const ChannelCondition> channelCondition) instead
*/
NS_DEPRECATED_3_41("Use GetThreeGppTable(const Ptr<const MobilityModel>, const Ptr<const "
"MobilityModel>, Ptr<const ChannelCondition>) instead")

View File

@@ -271,6 +271,7 @@ class UanPhy : public Object
*
* \param thresh Threshold SINR for proper reception in dB re 1 uPa.
*/
// NS_DEPRECATED() - tag for future removal
virtual void SetRxThresholdDb(double thresh) = 0;
/**

View File

@@ -472,6 +472,7 @@ class SimpleOfdmWimaxPhy : public WimaxPhy
* \deprecated The non-const \c Ptr<PacketBurst> argument is deprecated
* and will be changed to \c Ptrc<PacketBurst> in a future release.
*/
// NS_DEPRECATED() - tag for future removal
TracedCallback<Ptr<PacketBurst>> m_phyTxBeginTrace;
/**
@@ -482,6 +483,7 @@ class SimpleOfdmWimaxPhy : public WimaxPhy
* \deprecated The non-const \c Ptr<PacketBurst> argument is deprecated
* and will be changed to \c Ptrc<PacketBurst> in a future release.
*/
// NS_DEPRECATED() - tag for future removal
TracedCallback<Ptr<PacketBurst>> m_phyTxEndTrace;
/**
@@ -492,6 +494,7 @@ class SimpleOfdmWimaxPhy : public WimaxPhy
* \deprecated The non-const \c Ptr<PacketBurst> argument is deprecated
* and will be changed to \c Ptrc<PacketBurst> in a future release.
*/
// NS_DEPRECATED() - tag for future removal
TracedCallback<Ptr<PacketBurst>> m_phyTxDropTrace;
/**
@@ -502,6 +505,7 @@ class SimpleOfdmWimaxPhy : public WimaxPhy
* \deprecated The non-const \c Ptr<PacketBurst> argument is deprecated
* and will be changed to \c Ptrc<PacketBurst> in a future release.
*/
// NS_DEPRECATED() - tag for future removal
TracedCallback<Ptr<PacketBurst>> m_phyRxBeginTrace;
/**
@@ -512,6 +516,7 @@ class SimpleOfdmWimaxPhy : public WimaxPhy
* \deprecated The non-const \c Ptr<PacketBurst> argument is deprecated
* and will be changed to \c Ptrc<PacketBurst> in a future release.
*/
// NS_DEPRECATED() - tag for future removal
TracedCallback<Ptr<PacketBurst>> m_phyRxEndTrace;
/**
@@ -521,6 +526,7 @@ class SimpleOfdmWimaxPhy : public WimaxPhy
* \deprecated The non-const \c Ptr<PacketBurst> argument is deprecated
* and will be changed to \c Ptrc<PacketBurst> in a future release.
*/
// NS_DEPRECATED() - tag for future removal
TracedCallback<Ptr<PacketBurst>> m_phyRxDropTrace;
SNRToBlockErrorRateManager* m_snrToBlockErrorRateManager; ///< SNR to block error rate manager

View File

@@ -435,6 +435,7 @@ class WimaxNetDevice : public NetDevice
* The TracedCallback signature will then match \c Packet::Mac48Address
* and this typedef can be removed.
*/
// NS_DEPRECATED() - tag for future removal
typedef void (*TxRxTracedCallback)(Ptr<const Packet> packet, const Mac48Address& mac);
/**
* \deprecated The `const Mac48Address &` argument is deprecated
@@ -443,6 +444,7 @@ class WimaxNetDevice : public NetDevice
* and this typedef can be removed.
* \todo This member variable should be private.
*/
// NS_DEPRECATED() - tag for future removal
TracedCallback<Ptr<const Packet>, const Mac48Address&> m_traceRx;
/**
* \deprecated The `const Mac48Address &` argument is deprecated
@@ -451,6 +453,7 @@ class WimaxNetDevice : public NetDevice
* and this typedef can be removed.
* \todo This member variable should be private.
*/
// NS_DEPRECATED() - tag for future removal
TracedCallback<Ptr<const Packet>, const Mac48Address&> m_traceTx;
void DoDispose() override;