PLCnext API Documentation 23.6.0.37
NotImplementedException.hpp
1
2//
3// Copyright PHOENIX CONTACT Electronics GmbH
4//
6#pragma once
8#include "Arp/System/Commons/Exceptions/CommonException.hpp"
9
10namespace Arp { namespace System { namespace Commons
11{
12
15{
16public: // construction/destruction
17 template<typename... Args>
18 NotImplementedException(const char* message, const Args& ... args);
19 NotImplementedException(const String& message);
21 NotImplementedException(const String& message, const Exception& innerException);
22 NotImplementedException(String&& message, Exception&& innerException);
25 virtual ~NotImplementedException(void) = default;
26
27public: // static factory methods
28 static NotImplementedException Create(const char* functionName);
29 static NotImplementedException Create(const char* functionName, const Exception& innerException);
30
31protected: // overridden operations
32 Exception::Ptr Clone(void)const override;
33
34private: // deleted methods
35 NotImplementedException& operator=(const NotImplementedException& arg) = delete;
36
37private:
38 static const char* const defaultMessage;
39};
40
42// inline methods of class NotImplementedException
43
44
46template<typename... Args>
47inline NotImplementedException::NotImplementedException(const char* message, const Args& ... args)
48 : CommonException(ExceptionTypeId::NotImplemented, String::Format(message, args...))
49{
50}
51
54 : CommonException(ExceptionTypeId::NotImplemented, message)
55{
56}
57
60 : CommonException(ExceptionTypeId::NotImplemented, std::move(message))
61{
62}
63
65inline NotImplementedException::NotImplementedException(const String& message, const Exception& innerException)
66 : CommonException(ExceptionTypeId::NotImplemented, message, innerException)
67{
68}
69
72 : CommonException(ExceptionTypeId::NotImplemented, std::move(message), std::move(innerException))
73{
74}
75
78{
79 return NotImplementedException(defaultMessage, functionName);
80}
81
83inline NotImplementedException NotImplementedException::Create(const char* functionName, const Exception& innerException)
84{
85 return NotImplementedException(String::Format(defaultMessage, functionName), innerException);
86}
87
88}}} // end of namesapce Arp::System::Commons
This is the base class of all Arp exception classes.
Definition: Exception.hpp:16
std::shared_ptr< Exception > Ptr
The smart pointer tpye of this class.
Definition: Exception.hpp:19
This is the base class of common exception classes.
Definition: CommonException.hpp:19
This exception is used when a method is not implemented yet.
Definition: NotImplementedException.hpp:15
static NotImplementedException Create(const char *functionName)
Creates an NotImplementedException instance using a default message text.
Definition: NotImplementedException.hpp:77
NotImplementedException(const char *message, const Args &... args)
Constructs an NotImplementedException instance.
Definition: NotImplementedException.hpp:47
Exception::Ptr Clone(void) const override
Clones this instance.
static SelfType Format(const SelfType &format, const Args &... args)
Formats the format string using the .NET/Python syntax with the given variadic arguments.
Definition: BasicString.hxx:1493
@ System
System components used by the System, Device, Plc or Io domains.
ExceptionTypeId
Specifies the type id of any exception derived by <see cref="CommonException".
Definition: ExceptionTypeId.hpp:15
Root namespace for the PLCnext API
Namespace of the C++ standard library