dirty_tracked.hpp

Go to the documentation of this file.

//
// Copyright 2010-2015 Ettus Research LLC
// Copyright 2018 Ettus Research, a National Instruments Company
//
// SPDX-License-Identifier: GPL-3.0-or-later
//

#ifndef INCLUDED_UHD_UTILS_DIRTY_TRACKED_HPP
#define INCLUDED_UHD_UTILS_DIRTY_TRACKED_HPP

namespace uhd {
template <typename data_t> class dirty_tracked
{
public:
    dirty_tracked()
        : _data()
        , // data_t must have a default ctor
        _dirty(true)
    {
    }

    dirty_tracked(const data_t& value)
        : _data(value)
        , // data_t must have a copy ctor
        _dirty(true)
    {
    }

    dirty_tracked(const dirty_tracked& source)
    {
        *this = source;
    }

    UHD_INLINE const data_t& get() const
    {
        return _data;
    }

    UHD_INLINE bool is_dirty() const
    {
        return _dirty;
    }

    UHD_INLINE void mark_clean()
    {
        _dirty = false;
    }

    UHD_INLINE void force_dirty()
    {
        _dirty = true;
    }

    UHD_INLINE dirty_tracked& operator=(const data_t& value)
    {
        if (!(_data == value)) { // data_t must have an equality operator
            _dirty = true;
            _data  = value; // data_t must have an assignment operator
        }
        return *this;
    }

    UHD_INLINE dirty_tracked& operator=(const dirty_tracked& source)
    {
        if (!(_data == source._data)) {
            _dirty = true;
            _data  = source._data;
        }
        return *this;
    }

    UHD_INLINE operator const data_t&() const
    {
        return get();
    }

private:
    data_t _data;
    bool _dirty;
};

} // namespace uhd

#endif /* INCLUDED_UHD_UTILS_DIRTY_TRACKED_HPP */