PlcException.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#include "Arp/System/Core/Arp.h"
#include "Arp/System/Commons/Exceptions/CommonException.hpp"
 
namespace Arp { namespace System { namespace Commons { namespace Plc
{
 
class PlcException : public CommonException
{
public: // construction/destruction
    template<typename... Args>
    PlcException(const char* message, const Args& ... args);
    PlcException(const String& message);
    PlcException(String&& message);
    PlcException(const String& message, int skipStackTraceDepth);
    PlcException(String&& message, int skipStackTraceDepth);
    PlcException(const String& message, const Exception& innerException);
    PlcException(String&& message, Exception&& innerException);
    PlcException(const PlcException& arg) = default;
    PlcException(PlcException&& arg) = default;
    virtual ~PlcException(void) = default;
 
protected: // construction
    PlcException(ExceptionTypeId typeId, String&& message, int skipStackTraceDepth = DefaultSkipStackTraceDepth);
    PlcException(ExceptionTypeId typeId, const String& message, int skipStackTraceDepth = DefaultSkipStackTraceDepth);
    PlcException(ExceptionTypeId typeId, String&& message, Exception&& innerException, int skipStackTraceDepth = DefaultSkipStackTraceDepth);
    PlcException(ExceptionTypeId typeId, const String& message, const Exception& innerException, int skipStackTraceDepth = DefaultSkipStackTraceDepth);
 
public: // static factory methods
    static PlcException Create(int exc, const String& message);
    static PlcException CreateWithStackTrace(int exc, const String& message, const String& additionalStackTrace, int skipStackTraceDepth = 0);
 
protected: // overridden operations
    Exception::Ptr  Clone(void)const override;
 
private: // deleted methods
    PlcException& operator=(const PlcException& arg) = delete;
 
private:
    static const char* const defaultMessage;
 
protected:
    static const int DefaultSkipStackTraceDepth = 3;
};
 
// inline methods of class PlcException
 
template<typename... Args>
inline PlcException::PlcException(const char* message, const Args& ... args)
    : CommonException(ExceptionTypeId::Plc, String::Format(message, args...))
{
}
 
 
}}}} // end of namesapce Arp::System::Commons::Plc
 
// template specialization of PlcException formatter
template<> struct fmt::formatter<Arp::System::Commons::Plc::PlcException> : public fmt::ostream_formatter {};