NotImplementedException.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#include "Arp/Base/Core/Arp.hpp"
#include "Arp/Base/Core/PimplPtr.hxx"
#include "Arp/Base/Commons/Exceptions/CommonExceptionBase.hpp"
 
namespace Arp::Base::Commons::Exceptions
{
 
class ARP_BASE_COMMONS_EXPORT NotImplementedException : public CommonExceptionBase
{
public: // Impl forward declaration
    class Impl;
 
public: // construction
    template<typename... Args>
    explicit NotImplementedException(const char* message, const Args& ... args);
    explicit NotImplementedException(String&& message);
    explicit NotImplementedException(const String& message);
    NotImplementedException(String&& message, const Exception& innerException);
    NotImplementedException(const String& message, const Exception& innerException);
 
    // canonical construction/destruction/assignment
    NotImplementedException(const NotImplementedException& arg);
    NotImplementedException(NotImplementedException&& arg)noexcept;
    NotImplementedException& operator=(const NotImplementedException& arg);
    NotImplementedException& operator=(NotImplementedException&& arg)noexcept;
    ~NotImplementedException(void) override ;
 
protected: // construction
    NotImplementedException(ExceptionTypeId typeId, String&& message, StackCounter stackCounter);
 
public: // static factory operations
    static NotImplementedException Create(const char* functionName);
 
public: // internal operations
    Impl&       GetImpl(void);
    const Impl& GetImpl(void)const;
 
protected: // overridden operations
    Exception::Ptr  Clone(void)const override ;
 
private: // static factory methods
    static NotImplementedException  CreateImpl(const char* functionName, StackCounter stackCounter);
 
private: // Impl usings
    using Pimpl = PimplPtr<Impl, true>;
 
private: // Impl fields
    Pimpl   pimpl;
};
 
// inline methods of class ArgumentException
 
template<typename... Args>
inline NotImplementedException::NotImplementedException(const char* message, const Args& ... args)
    : NotImplementedException(ExceptionTypeId::NotImplemented, String::Format(message, args...), StackCounter())
{
}
 
} // end of namespace Arp::Base::Commons::Exceptions
 
namespace Arp {
// Import exception into Arp namespace as Arp::System::Commons library does
using Arp::Base::Commons::Exceptions::NotImplementedException;
} // end of namespace Arp
// template specialization of NotImplementedException formatter
template<> struct fmt::formatter<Arp::Base::Commons::Exceptions::NotImplementedException> : public fmt::ostream_formatter {};