PLCnext API Documentation 26.6.0.38
NotSupportedException.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
4//
6#pragma once
8#include "Arp/Base/Core/PimplPtr.hxx"
9#include "Arp/Base/Commons/Exceptions/CommonExceptionBase.hpp"
10
11namespace Arp::Base::Commons::Exceptions
12{
13
15class ARP_BASE_COMMONS_EXPORT NotSupportedException : public CommonExceptionBase
16{
17public: // Impl forward declaration
18 class Impl;
19
20public: // construction
21 template<typename... Args>
22 explicit NotSupportedException(const char* message, const Args& ... args);
23 explicit NotSupportedException(String&& message);
24 explicit NotSupportedException(const String& message);
25 NotSupportedException(String&& message, const Exception& innerException);
26 NotSupportedException(const String& message, const Exception& innerException);
27
28 // canonical construction/destruction/assignment
33 ~NotSupportedException(void) override ;
34
35protected: // construction
36 NotSupportedException(ExceptionTypeId typeId, String&& message, StackCounter stackCounter);
37
38public: // static factory operations
39 static NotSupportedException Create(const String& message);
40
41public: // internal operations
42 Impl& GetImpl(void);
43 const Impl& GetImpl(void)const;
44
45protected: // overridden operations
46 Exception::Ptr Clone(void)const override ;
47
48private: // static factory methods
49 static NotSupportedException CreateImpl(const String& message, StackCounter stackCounter);
50
51private: // Impl usings
53
54private: // Impl fields
55 Pimpl pimpl;
56};
57
59// inline methods of class ArgumentException
60
67template<typename... Args>
68inline NotSupportedException::NotSupportedException(const char* message, const Args& ... args)
69 : NotSupportedException(ExceptionTypeId::NotSupported, String::Format(message, args...), StackCounter())
70{
71}
72
73} // end of namespace Arp::Base::Commons::Exceptions
74
75namespace Arp {
76// Import exception into Arp namespace as Arp::System::Commons library does
78} // end of namespace Arp
80// template specialization of NotSupportedException formatter
81template<> struct fmt::formatter<Arp::Base::Commons::Exceptions::NotSupportedException> : public fmt::ostream_formatter {};
This class serves as base class for all Arp commons exceptions.
Definition: CommonExceptionBase.hpp:24
This exception is thrown when a not supported operation is invoked.
Definition: NotSupportedException.hpp:16
NotSupportedException & operator=(const NotSupportedException &arg)
Default copy-assignment operator.
NotSupportedException(NotSupportedException &&arg) noexcept
Default move constructor.
NotSupportedException(const NotSupportedException &arg)
Default copy constructor.
NotSupportedException(const char *message, const Args &... args)
Creates an NotSupportedException with message.
Definition: NotSupportedException.hpp:68
NotSupportedException & operator=(NotSupportedException &&arg) noexcept
Default move-assignment operator.
~NotSupportedException(void) override
Default destructor.
This class is used to count sequenced operation calls, which are e.g. invoked during an exception thr...
Definition: StackCounter.hpp:20
This is the base class of all Arp exception classes.
Definition: Exception.hpp:21
std::unique_ptr< Exception > Ptr
The smart pointer type of this class.
Definition: Exception.hpp:27
Adapter class to implement PImpl idiom.
Definition: PimplPtr.hxx:15
This class represents the Arp String. The implementation is based on std::string.
Definition: String.hpp:39
@ Create
Creates a new file. If the file already exists, it is overwritten.
ExceptionTypeId
Specifies the type id of any exception derived by <see cref="CommonException".
Definition: ExceptionTypeId.hpp:15
Root namespace for the PLCnext API