traced-value.h

Go to the documentation of this file.

/*
 * Copyright (c) 2005,2006,2007 INRIA
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 */
#ifndef TRACED_VALUE_H
#define TRACED_VALUE_H
 
#include "boolean.h"
#include "double.h"
#include "enum.h"
#include "integer.h"
#include "traced-callback.h"
#include "uinteger.h"
 
/**
 * @file
 * @ingroup tracing
 * ns3::TracedValue declaration and template implementation.
 */
 
/**
 * Logging macro for TracedValue.
 *
 * No NS_LOG_... here.  When logging is needed use something like
 * @code
 *   #define TRACED_VALUE_DEBUG(x)                  \
 *     std::cout << __FILE__ << ":" << __FUNCTION__    \
 *               << "(" << __LINE__ << ") "           \
 *               << x << std::endl
 * @endcode
 */
#define TRACED_VALUE_DEBUG(x)
 
namespace ns3
{
 
/**
 * @ingroup core
 * @defgroup tracing Tracing
 * @brief Publish/subscribe tools to collect and report changes to any
 *        values used by the various model components.
 *
 * Additional callback function signatures defined elsewhere:
 *   - TracedValueCallback::Time
 *   - TracedValueCallback::SequenceNumber32
 *   - TracedValueCallback::LrWpanMacState
 *   - TracedValueCallback::LrWpanPhyEnumeration
 */
 
/**
 * @ingroup tracing
 *
 * @brief TracedValue Callback function types.
 */
namespace TracedValueCallback
{
 
/**
 * @name TracedValueCallback Signatures for POD.
 * @{
 */
/**
 *  TracedValue Callback signature for POD.
 * @{
 * @param [in] oldValue original value of the traced variable
 * @param [in] newValue new value of the traced variable
 */
typedef void (*Bool)(bool oldValue, bool newValue);
typedef void (*Int8)(int8_t oldValue, int8_t newValue);
typedef void (*Uint8)(uint8_t oldValue, uint8_t newValue);
typedef void (*Int16)(int16_t oldValue, int16_t newValue);
typedef void (*Uint16)(uint16_t oldValue, uint16_t newValue);
typedef void (*Int32)(int32_t oldValue, int32_t newValue);
typedef void (*Uint32)(uint32_t oldValue, uint32_t newValue);
typedef void (*Int64)(int64_t oldValue, int64_t newValue);
typedef void (*Uint64)(uint64_t oldValue, uint64_t newValue);
typedef void (*Double)(double oldValue, double newValue);
/**@}*/
/** TracedValue Callback signature for void. */
typedef void (*Void)();
/**@}*/
 
} // namespace TracedValueCallback
 
/**
 * @ingroup tracing
 *
 * @brief Trace classes with value semantics
 *
 * If you want to trace the change of value of a class or
 * primitive type which have value semantics (they _must_
 * support operator !=), you can wrap them in an instance of
 * this template.  This instance will behave just like
 * the original class (if it did not export any special method),
 * and will define Connect/DisconnectWithoutContext methods to work
 * with MakeTraceSourceAccessor.
 *
 * @tparam T \explicit The type of the underlying value being traced.
 */
template <typename T>
class TracedValue
{
  public:
    /** Default constructor. */
    TracedValue()
        : m_v()
    {
    }
 
    /**
     * Copy constructor.
     * @param [in] o The value to copy.
     */
    TracedValue(const TracedValue& o)
        : m_v(o.m_v)
    {
    }
 
    /**
     * Construct from an explicit variable.
     * @param [in] v The variable to trace.
     */
    TracedValue(const T& v)
        : m_v(v)
    {
    }
 
    /**
     * Cast to the underlying type.
     * @returns The underlying value.
     */
    operator T() const
    {
        return m_v;
    }
 
    /**
     * Assignment.
     * @param [in] o The value to assign to this instance.
     * @return This TracedValue.
     */
    TracedValue& operator=(const TracedValue& o)
    {
        TRACED_VALUE_DEBUG("x=");
        Set(o.m_v);
        return *this;
    }
 
    /**
     * Copy from a TracedValue of a compatible type.
     * @tparam U \deduced The underlying type of the other TracedValue.
     * @param [in] other The other TracedValuet to copy.
     */
    template <typename U>
    TracedValue(const TracedValue<U>& other)
        : m_v(other.Get())
    {
    }
 
    /**
     * Copy from a variable type compatible with this underlying type.
     * @tparam U \deduced Type of the other variable.
     * @param [in] other The other variable to copy.
     */
    template <typename U>
    TracedValue(const U& other)
        : m_v((T)other)
    {
    }
 
    /**
     * Connect a Callback (without context.)
     *
     * @param [in] cb The callback to connect.
     */
    void ConnectWithoutContext(const CallbackBase& cb)
    {
        m_cb.ConnectWithoutContext(cb);
    }
 
    /**
     * Connect a Callback with a context string.
     *
     * The context string will be provided as the first argument to the
     * Callback function.
     *
     * @param [in] cb The Callback to connect to the target trace source.
     * @param [in] path The context to bind to the user callback.
     */
    void Connect(const CallbackBase& cb, std::string path)
    {
        m_cb.Connect(cb, path);
    }
 
    /**
     * Disconnect a Callback which was connected without context.
     *
     * @param [in] cb The Callback to disconnect.
     */
    void DisconnectWithoutContext(const CallbackBase& cb)
    {
        m_cb.DisconnectWithoutContext(cb);
    }
 
    /**
     * Disconnect a Callback which was connected with context.
     *
     * @param [in] cb The Callback to disconnect.
     * @param [in] path The context to bind to the user callback.
     */
    void Disconnect(const CallbackBase& cb, std::string path)
    {
        m_cb.Disconnect(cb, path);
    }
 
    /**
     * Set the value of the underlying variable.
     *
     * If the new value differs from the old, the Callback will be invoked.
     * @param [in] v The new value.
     */
    void Set(const T& v)
    {
        if (m_v != v)
        {
            m_cb(m_v, v);
            m_v = v;
        }
    }
 
    /**
     * Get the underlying value.
     * @returns The value.
     */
    T Get() const
    {
        return m_v;
    }
 
    /**
     * Pre/post- increment/decrement operator.
     *
     * This invokes the Callback.
     * @returns This TracedValue.
     */
    /**@{*/
    TracedValue& operator++()
    {
        TRACED_VALUE_DEBUG("++x");
        T tmp = Get();
        ++tmp;
        Set(tmp);
        return *this;
    }
 
    TracedValue& operator--()
    {
        TRACED_VALUE_DEBUG("--x");
        T tmp = Get();
        --tmp;
        Set(tmp);
        return *this;
    }
 
    TracedValue operator++(int)
    {
        TRACED_VALUE_DEBUG("x++");
        TracedValue old(*this);
        T tmp = Get();
        tmp++;
        Set(tmp);
        return old;
    }
 
    TracedValue operator--(int)
    {
        TRACED_VALUE_DEBUG("x--");
        TracedValue old(*this);
        T tmp = Get();
        tmp--;
        Set(tmp);
        return old;
    }
 
    /**@}*/
 
  private:
    /** The underlying value. */
    T m_v;
    /** The connected Callback. */
    TracedCallback<T, T> m_cb;
};
 
/********************************************************************
   Operator implementations for TracedValue
 ********************************************************************/
 
/**
 * @ingroup tracing
 */
/**@{*/
/**
 * Output streamer for TracedValue.
 *
 * The underlying value will be written to the stream.
 *
 * @tparam T \deduced The underlying type of the TracedValue.
 * @param [in,out] os The output stream.
 * @param [in] rhs The TracedValue to stream.
 * @returns The stream.
 */
template <typename T>
std::ostream&
operator<<(std::ostream& os, const TracedValue<T>& rhs)
{
    return os << rhs.Get();
}
 
/**
 * Boolean operator for TracedValue.
 * @tparam T \deduced The underlying type held by the left-hand argument.
 * @tparam U \deduced The underlying type held by the right-hand argument.
 * @param [in] lhs The left-hand argument.
 * @param [in] rhs The right-hand argument.
 * @returns The Boolean result of comparing the underlying values.
 */
template <typename T, typename U>
bool
operator==(const TracedValue<T>& lhs, const TracedValue<U>& rhs)
{
    TRACED_VALUE_DEBUG("x==x");
    return lhs.Get() == rhs.Get();
}
 
/** @copydoc operator==(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
bool
operator==(const TracedValue<T>& lhs, const U& rhs)
{
    TRACED_VALUE_DEBUG("x==");
    return lhs.Get() == rhs;
}
 
/** @copydoc operator==(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
bool
operator==(const U& lhs, const TracedValue<T>& rhs)
{
    TRACED_VALUE_DEBUG("==x");
    return lhs == rhs.Get();
}
 
/** @copydoc operator==(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
bool
operator!=(const TracedValue<T>& lhs, const TracedValue<U>& rhs)
{
    TRACED_VALUE_DEBUG("x!=x");
    return lhs.Get() != rhs.Get();
}
 
/** @copydoc operator==(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
bool
operator!=(const TracedValue<T>& lhs, const U& rhs)
{
    TRACED_VALUE_DEBUG("x!=");
    return lhs.Get() != rhs;
}
 
/** @copydoc operator==(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
bool
operator!=(const U& lhs, const TracedValue<T>& rhs)
{
    TRACED_VALUE_DEBUG("!=x");
    return lhs != rhs.Get();
}
 
/** @copydoc operator==(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
bool
operator<=(const TracedValue<T>& lhs, const TracedValue<U>& rhs)
{
    TRACED_VALUE_DEBUG("x<=x");
    return lhs.Get() <= rhs.Get();
}
 
/** @copydoc operator==(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
bool
operator<=(const TracedValue<T>& lhs, const U& rhs)
{
    TRACED_VALUE_DEBUG("x<=");
    return lhs.Get() <= rhs;
}
 
/** @copydoc operator==(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
bool
operator<=(const U& lhs, const TracedValue<T>& rhs)
{
    TRACED_VALUE_DEBUG("<=x");
    return lhs <= rhs.Get();
}
 
/** @copydoc operator==(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
bool
operator>=(const TracedValue<T>& lhs, const TracedValue<U>& rhs)
{
    TRACED_VALUE_DEBUG("x>=x");
    return lhs.Get() >= rhs.Get();
}
 
/** @copydoc operator==(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
bool
operator>=(const TracedValue<T>& lhs, const U& rhs)
{
    TRACED_VALUE_DEBUG("x>=");
    return lhs.Get() >= rhs;
}
 
/** @copydoc operator==(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
bool
operator>=(const U& lhs, const TracedValue<T>& rhs)
{
    TRACED_VALUE_DEBUG(">=x");
    return lhs >= rhs.Get();
}
 
/** @copydoc operator==(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
bool
operator<(const TracedValue<T>& lhs, const TracedValue<U>& rhs)
{
    TRACED_VALUE_DEBUG("x<x");
    return lhs.Get() < rhs.Get();
}
 
/** @copydoc operator==(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
bool
operator<(const TracedValue<T>& lhs, const U& rhs)
{
    TRACED_VALUE_DEBUG("x<");
    return lhs.Get() < rhs;
}
 
/** @copydoc operator==(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
bool
operator<(const U& lhs, const TracedValue<T>& rhs)
{
    TRACED_VALUE_DEBUG("<x");
    return lhs < rhs.Get();
}
 
/** @copydoc operator==(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
bool
operator>(const TracedValue<T>& lhs, const TracedValue<U>& rhs)
{
    TRACED_VALUE_DEBUG("x>x");
    return lhs.Get() > rhs.Get();
}
 
/** @copydoc operator==(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
bool
operator>(const TracedValue<T>& lhs, const U& rhs)
{
    TRACED_VALUE_DEBUG("x>");
    return lhs.Get() > rhs;
}
 
/** @copydoc operator==(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
bool
operator>(const U& lhs, const TracedValue<T>& rhs)
{
    TRACED_VALUE_DEBUG(">x");
    return lhs > rhs.Get();
}
 
/**
 * Infix arithmetic operator for TracedValue.
 *
 * This returns the arithmetic result in a new TracedValue,
 * which has no Callback connected.
 *
 * @tparam T \deduced The underlying type held by the left-hand argument.
 * @tparam U \deduced The underlying type held by the right-hand argument.
 * @param [in] lhs The left-hand argument.
 * @param [in] rhs The right-hand argument.
 * @returns The result of doing the operator on
 *     the underlying values.
 */
// clang-format off
// Clang-format guard needed for version 18 only
template <typename T, typename U>
auto
operator+(const TracedValue<T>& lhs, const TracedValue<U>& rhs)
    -> TracedValue<decltype(lhs.Get() + rhs.Get())>
// clang-format on
{
    TRACED_VALUE_DEBUG("x+x");
    return TracedValue<decltype(lhs.Get() + rhs.Get())>(lhs.Get() + rhs.Get());
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
auto
operator+(const TracedValue<T>& lhs, const U& rhs) -> TracedValue<decltype(lhs.Get() + rhs)>
{
    TRACED_VALUE_DEBUG("x+");
    return TracedValue<decltype(lhs.Get() + rhs)>(lhs.Get() + rhs);
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
auto
operator+(const U& lhs, const TracedValue<T>& rhs) -> TracedValue<decltype(lhs + rhs.Get())>
{
    TRACED_VALUE_DEBUG("+x");
    return TracedValue<decltype(lhs + rhs.Get())>(lhs + rhs.Get());
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
// clang-format off
// Clang-format guard needed for version 18 only
template <typename T, typename U>
auto
operator-(const TracedValue<T>& lhs, const TracedValue<U>& rhs)
    -> TracedValue<decltype(lhs.Get() - rhs.Get())>
// clang-format on
{
    TRACED_VALUE_DEBUG("x-x");
    return TracedValue<decltype(lhs.Get() - rhs.Get())>(lhs.Get() - rhs.Get());
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
auto
operator-(const TracedValue<T>& lhs, const U& rhs) -> TracedValue<decltype(lhs.Get() - rhs)>
{
    TRACED_VALUE_DEBUG("x-");
    return TracedValue<decltype(lhs.Get() - rhs)>(lhs.Get() - rhs);
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
auto
operator-(const U& lhs, const TracedValue<T>& rhs) -> TracedValue<decltype(lhs - rhs.Get())>
{
    TRACED_VALUE_DEBUG("-x");
    return TracedValue<decltype(lhs - rhs.Get())>(lhs - rhs.Get());
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
// clang-format off
// Clang-format guard needed for version 18 only
template <typename T, typename U>
auto
operator*(const TracedValue<T>& lhs, const TracedValue<U>& rhs)
    -> TracedValue<decltype(lhs.Get() * rhs.Get())>
// clang-format on
{
    TRACED_VALUE_DEBUG("x*x");
    return TracedValue<decltype(lhs.Get() * rhs.Get())>(lhs.Get() * rhs.Get());
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
auto
operator*(const TracedValue<T>& lhs, const U& rhs) -> TracedValue<decltype(lhs.Get() * rhs)>
{
    TRACED_VALUE_DEBUG("x*");
    return TracedValue<decltype(lhs.Get() * rhs)>(lhs.Get() * rhs);
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
auto
operator*(const U& lhs, const TracedValue<T>& rhs) -> TracedValue<decltype(lhs + rhs.Get())>
{
    TRACED_VALUE_DEBUG("*x");
    return TracedValue<decltype(lhs + rhs.Get())>(lhs * rhs.Get());
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
// clang-format off
// Clang-format guard needed for version 18 only
template <typename T, typename U>
auto
operator/(const TracedValue<T>& lhs, const TracedValue<U>& rhs)
    -> TracedValue<decltype(lhs.Get() / rhs.Get())>
// clang-format on
{
    TRACED_VALUE_DEBUG("x/x");
    return TracedValue<decltype(lhs.Get() / rhs.Get())>(lhs.Get() / rhs.Get());
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
auto
operator/(const TracedValue<T>& lhs, const U& rhs) -> TracedValue<decltype(lhs.Get() / rhs)>
{
    TRACED_VALUE_DEBUG("x/");
    return TracedValue<decltype(lhs.Get() / rhs)>(lhs.Get() / rhs);
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
auto
operator/(const U& lhs, const TracedValue<T>& rhs) -> TracedValue<decltype(lhs / rhs.Get())>
{
    TRACED_VALUE_DEBUG("/x");
    return TracedValue<decltype(lhs / rhs.Get())>(lhs / rhs.Get());
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
// clang-format off
// Clang-format guard needed for version 18 only
template <typename T, typename U>
auto
operator%(const TracedValue<T>& lhs, const TracedValue<U>& rhs)
    -> TracedValue<decltype(lhs.Get() % rhs.Get())>
// clang-format on
{
    TRACED_VALUE_DEBUG("x%x");
    return TracedValue<decltype(lhs.Get() % rhs.Get())>(lhs.Get() % rhs.Get());
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
auto
operator%(const TracedValue<T>& lhs, const U& rhs) -> TracedValue<decltype(lhs.Get() % rhs)>
{
    TRACED_VALUE_DEBUG("x%");
    return TracedValue<decltype(lhs.Get() % rhs)>(lhs.Get() % rhs);
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
auto
operator%(const U& lhs, const TracedValue<T>& rhs) -> TracedValue<decltype(lhs % rhs.Get())>
{
    TRACED_VALUE_DEBUG("%x");
    return TracedValue<decltype(lhs % rhs.Get())>(lhs % rhs.Get());
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
// clang-format off
// Clang-format guard needed for version 18 only
template <typename T, typename U>
auto
operator^(const TracedValue<T>& lhs, const TracedValue<U>& rhs)
    -> TracedValue<decltype(lhs.Get() ^ rhs.Get())>
// clang-format on
{
    TRACED_VALUE_DEBUG("x^x");
    return TracedValue<decltype(lhs.Get() ^ rhs.Get())>(lhs.Get() ^ rhs.Get());
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
auto
operator^(const TracedValue<T>& lhs, const U& rhs) -> TracedValue<decltype(lhs.Get() ^ rhs)>
{
    TRACED_VALUE_DEBUG("x^");
    return TracedValue<decltype(lhs.Get() ^ rhs)>(lhs.Get() ^ rhs);
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
auto
operator^(const U& lhs, const TracedValue<T>& rhs) -> TracedValue<decltype(lhs ^ rhs.Get())>
{
    TRACED_VALUE_DEBUG("^x");
    return TracedValue<decltype(lhs ^ rhs.Get())>(lhs ^ rhs.Get());
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
// clang-format off
// Clang-format guard needed for version 18 only
template <typename T, typename U>
auto
operator|(const TracedValue<T>& lhs, const TracedValue<U>& rhs)
    -> TracedValue<decltype(lhs.Get() | rhs.Get())>
// clang-format on
{
    TRACED_VALUE_DEBUG("x|x");
    return TracedValue<decltype(lhs.Get() | rhs.Get())>(lhs.Get() | rhs.Get());
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
auto
operator|(const TracedValue<T>& lhs, const U& rhs) -> TracedValue<decltype(lhs.Get() | rhs)>
{
    TRACED_VALUE_DEBUG("x|");
    return TracedValue<decltype(lhs.Get() | rhs)>(lhs.Get() | rhs);
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
auto
operator|(const U& lhs, const TracedValue<T>& rhs) -> TracedValue<decltype(lhs | rhs.Get())>
{
    TRACED_VALUE_DEBUG("|x");
    return TracedValue<decltype(lhs | rhs.Get())>(lhs | rhs.Get());
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
// clang-format off
// Clang-format guard needed for version 18 only
template <typename T, typename U>
auto
operator&(const TracedValue<T>& lhs, const TracedValue<U>& rhs)
    -> TracedValue<decltype(lhs.Get() & rhs.Get())>
// clang-format on
{
    TRACED_VALUE_DEBUG("x&x");
    return TracedValue<decltype(lhs.Get() & rhs.Get())>(lhs.Get() & rhs.Get());
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
auto
operator&(const TracedValue<T>& lhs, const U& rhs) -> TracedValue<decltype(lhs.Get() & rhs)>
{
    TRACED_VALUE_DEBUG("x&");
    return TracedValue<decltype(lhs.Get() & rhs)>(lhs.Get() & rhs);
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
auto
operator&(const U& lhs, const TracedValue<T>& rhs) -> TracedValue<decltype(lhs & rhs.Get())>
{
    TRACED_VALUE_DEBUG("&x");
    return TracedValue<decltype(lhs & rhs.Get())>(lhs & rhs.Get());
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
// clang-format off
// Clang-format guard needed for version 18 only
template <typename T, typename U>
auto
operator<<(const TracedValue<T>& lhs, const TracedValue<U>& rhs)
    -> TracedValue<decltype(lhs.Get() << rhs.Get())>
// clang-format on
{
    TRACED_VALUE_DEBUG("x<<x");
    return TracedValue<decltype(lhs.Get() << rhs.Get())>(lhs.Get() << rhs.Get());
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
auto
operator<<(const TracedValue<T>& lhs, const U& rhs) -> TracedValue<decltype(lhs.Get() << rhs)>
{
    TRACED_VALUE_DEBUG("x<<");
    return TracedValue<decltype(lhs.Get() << rhs)>(lhs.Get() << rhs);
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
auto
operator<<(const U& lhs, const TracedValue<T>& rhs) -> TracedValue<decltype(lhs << rhs.Get())>
{
    TRACED_VALUE_DEBUG("<<x");
    return TracedValue<decltype(lhs << rhs.Get())>(lhs << rhs.Get());
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
// clang-format off
// Clang-format guard needed for version 18 only
template <typename T, typename U>
auto
operator>>(const TracedValue<T>& lhs, const TracedValue<U>& rhs)
    -> TracedValue<decltype(lhs.Get() >> rhs.Get())>
// clang-format on
{
    TRACED_VALUE_DEBUG("x>>x");
    return TracedValue<decltype(lhs.Get() >> rhs.Get())>(lhs.Get() >> rhs.Get());
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
auto
operator>>(const TracedValue<T>& lhs, const U& rhs) -> TracedValue<decltype(lhs.Get() >> rhs)>
{
    TRACED_VALUE_DEBUG("x>>");
    return TracedValue<decltype(lhs.Get() >> rhs)>(lhs.Get() >> rhs);
}
 
/** @copydoc operator+(const TracedValue<T>&lhs,const TracedValue<U>&rhs) */
template <typename T, typename U>
auto
operator>>(const U& lhs, const TracedValue<T>& rhs) -> TracedValue<decltype(lhs >> rhs.Get())>
{
    TRACED_VALUE_DEBUG(">>x");
    return TracedValue<decltype(lhs >> rhs.Get())>(lhs >> rhs.Get());
}
 
/**
 * Operator assignment for TracedValue.
 *
 * The result of the arithmetic operation on the underlying values
 * is assigned to the \c lhs TracedValue.  If the new value
 * is different, the Callback will be invoked.
 *
 * @tparam T \deduced The underlying type held by the left-hand argument.
 * @tparam U \deduced The underlying type held by the right-hand argument.
 * @param [in] lhs The left-hand argument.
 * @param [in] rhs The right-hand argument.
 * @returns The result of doing the operator on
 *     the underlying values.
 */
template <typename T, typename U>
TracedValue<T>&
operator+=(TracedValue<T>& lhs, const U& rhs)
{
    TRACED_VALUE_DEBUG("x+=");
    T tmp = lhs.Get();
    tmp += rhs;
    lhs.Set(tmp);
    return lhs;
}
 
/** @copydoc operator+=(TracedValue<T>&lhs,const U&rhs) */
template <typename T, typename U>
TracedValue<T>&
operator-=(TracedValue<T>& lhs, const U& rhs)
{
    TRACED_VALUE_DEBUG("x-=");
    T tmp = lhs.Get();
    tmp -= rhs;
    lhs.Set(tmp);
    return lhs;
}
 
/** @copydoc operator+=(TracedValue<T>&lhs,const U&rhs) */
template <typename T, typename U>
TracedValue<T>&
operator*=(TracedValue<T>& lhs, const U& rhs)
{
    TRACED_VALUE_DEBUG("x*=");
    T tmp = lhs.Get();
    tmp *= rhs;
    lhs.Set(tmp);
    return lhs;
}
 
/** @copydoc operator+=(TracedValue<T>&lhs,const U&rhs) */
template <typename T, typename U>
TracedValue<T>&
operator/=(TracedValue<T>& lhs, const U& rhs)
{
    TRACED_VALUE_DEBUG("x/=");
    T tmp = lhs.Get();
    tmp /= rhs;
    lhs.Set(tmp);
    return lhs;
}
 
/** @copydoc operator+=(TracedValue<T>&lhs,const U&rhs) */
template <typename T, typename U>
TracedValue<T>&
operator%=(TracedValue<T>& lhs, const U& rhs)
{
    TRACED_VALUE_DEBUG("x%=");
    T tmp = lhs.Get();
    tmp %= rhs;
    lhs.Set(tmp);
    return lhs;
}
 
/** @copydoc operator+=(TracedValue<T>&lhs,const U&rhs) */
template <typename T, typename U>
TracedValue<T>&
operator<<=(TracedValue<T>& lhs, const U& rhs)
{
    TRACED_VALUE_DEBUG("x<<=");
    T tmp = lhs.Get();
    tmp <<= rhs;
    lhs.Set(tmp);
    return lhs;
}
 
/** @copydoc operator+=(TracedValue<T>&lhs,const U&rhs) */
template <typename T, typename U>
TracedValue<T>&
operator>>=(TracedValue<T>& lhs, const U& rhs)
{
    TRACED_VALUE_DEBUG("x>>=");
    T tmp = lhs.Get();
    tmp >>= rhs;
    lhs.Set(tmp);
    return lhs;
}
 
/** @copydoc operator+=(TracedValue<T>&lhs,const U&rhs) */
template <typename T, typename U>
TracedValue<T>&
operator&=(TracedValue<T>& lhs, const U& rhs)
{
    TRACED_VALUE_DEBUG("x&=");
    T tmp = lhs.Get();
    tmp &= rhs;
    lhs.Set(tmp);
    return lhs;
}
 
/** @copydoc operator+=(TracedValue<T>&lhs,const U&rhs) */
template <typename T, typename U>
TracedValue<T>&
operator|=(TracedValue<T>& lhs, const U& rhs)
{
    TRACED_VALUE_DEBUG("x|=");
    T tmp = lhs.Get();
    tmp |= rhs;
    lhs.Set(tmp);
    return lhs;
}
 
/** @copydoc operator+=(TracedValue<T>&lhs,const U&rhs) */
template <typename T, typename U>
TracedValue<T>&
operator^=(TracedValue<T>& lhs, const U& rhs)
{
    TRACED_VALUE_DEBUG("x^=");
    T tmp = lhs.Get();
    tmp ^= rhs;
    lhs.Set(tmp);
    return lhs;
}
 
/**
 * Unary arithmetic operator for TracedValue.
 *
 * @tparam T \deduced The underlying type held by the TracedValue.
 * @param [in] lhs The TracedValue.
 * @returns The result of doing the operator on
 *     the underlying values.
 */
template <typename T>
TracedValue<T>
operator+(const TracedValue<T>& lhs)
{
    TRACED_VALUE_DEBUG("(+x)");
    return TracedValue<T>(+lhs.Get());
}
 
/** @copydoc operator+(const TracedValue<T>&lhs) */
template <typename T>
TracedValue<T>
operator-(const TracedValue<T>& lhs)
{
    TRACED_VALUE_DEBUG("(-x)");
    return TracedValue<T>(-lhs.Get());
}
 
/** @copydoc operator+(const TracedValue<T>&lhs) */
template <typename T>
TracedValue<T>
operator~(const TracedValue<T>& lhs)
{
    TRACED_VALUE_DEBUG("(~x)");
    return TracedValue<T>(~lhs.Get());
}
 
/** @copydoc operator+(const TracedValue<T>&lhs) */
template <typename T>
TracedValue<T>
operator!(const TracedValue<T>& lhs)
{
    TRACED_VALUE_DEBUG("(!x)");
    return TracedValue<T>(!lhs.Get());
}
 
/**@}*/ // \ingroup tracing
 
} // namespace ns3
 
#endif /* TRACED_VALUE_H */