non_copyable.hpp

// Copyright 2024 TeiaCare
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
#pragma once
 
namespace tc::sdk
{
/*!
 * \class non_copyable
 * \brief Utility class expected to be used as a base class to define non-copyable classes.
 * \note It is not necessary to publicly derive from this class.
 * It is sufficient to derive privately to prevent copy operations on the derived class.
 * \code
   class my_class : private non_copyable
   { ... };
   \endcode
 */
class non_copyable
{
protected:
    /*!
     * \brief Constructor
     *
     * Default constructor for tc::sdk::non_copyable
     */
    inline non_copyable() = default;
 
    /*!
     * \brief Destructor
     *
     * Default constructor for tc::sdk::non_copyable
     */
    inline ~non_copyable() = default;
 
    /*!
     * \brief Copy constructor
     *
     * Copy constructor marked as deleted.
     */
    non_copyable(const non_copyable&) = delete;
 
    /*!
     * \brief Copy assignment operator
     *
     * Copy assignment operator marked as deleted.
     */
    non_copyable& operator=(const non_copyable&) = delete;
 
    /*!
     * \brief Move constructor
     *
     * Move constructor marked as defaulted.
     */
    non_copyable(non_copyable&&) noexcept = default;
 
    /*!
     * \brief Move assignment operator
     *
     * Move assignment operator marked as defaulted.
     */
    non_copyable& operator=(non_copyable&&) noexcept = default;
};
 
}