PLCnext API Documentation  21.0.0.35466
TimeoutException.hpp
1 //
3 // Copyright PHOENIX CONTACT Electronics GmbH
4 //
6 #pragma once
7 #include "Arp/System/Core/Arp.h"
8 #include "Arp/System/Commons/Exceptions/CommonException.hpp"
9 
10 namespace Arp { namespace System { namespace Commons
11 {
12 
15 {
16 public: // construction/destruction
17  template<typename... Args>
18  TimeoutException(const char* message, const Args& ... args);
19  TimeoutException(const String& message);
20  TimeoutException(String&& message);
21  TimeoutException(const String& message, const Exception& innerException);
22  TimeoutException(String&& message, Exception&& innerException);
23  TimeoutException(const TimeoutException& arg) = default;
24  TimeoutException(TimeoutException&& arg) = default;
25  virtual ~TimeoutException(void) = default;
26 
27 public: // static factory methods
28  static TimeoutException Create(void);
29  static TimeoutException Create(const Exception& innerException);
30 
31 protected: // overridden operations
32  Exception::Ptr Clone(void)const override;
33 
34 private: // deleted methods
35  TimeoutException& operator=(const TimeoutException& arg) = delete;
36 
37 private:
38  static const char* const defaultMessage;
39 };
40 
42 // inline methods of class TimeoutException
43 
45 template<typename... Args>
46 inline TimeoutException::TimeoutException(const char* message, const Args& ... args)
47  : CommonException(ExceptionTypeId::Timeout, String::Format(message, args...))
48 {
49 }
50 
53  : CommonException(ExceptionTypeId::Timeout, message)
54 {
55 }
56 
59  : CommonException(ExceptionTypeId::Timeout, std::move(message))
60 {
61 }
62 
64 inline TimeoutException::TimeoutException(const String& message, const Exception& innerException)
65  : CommonException(ExceptionTypeId::Timeout, message, innerException)
66 {
67 }
68 
70 inline TimeoutException::TimeoutException(String&& message, Exception&& innerException)
71  : CommonException(ExceptionTypeId::Timeout, std::move(message), std::move(innerException))
72 {
73 }
74 
77 {
78  return TimeoutException(defaultMessage);
79 }
80 
83 {
84  return TimeoutException(String::Format(defaultMessage, innerException));
85 }
86 
87 }}} // end of namesapce Arp::System::Commons
This is the base class of common exception classes.
Definition: CommonException.hpp:18
This exception is used when a timeout occurs.
Definition: TimeoutException.hpp:14
String Format(int indentLevel, bool withInnerException) const override
Formats this exception using the given indent level.
Namespace of the C++ standard library
static TimeoutException Create(void)
Creates an TimeoutException instance using a default message text.
Definition: TimeoutException.hpp:76
TimeoutException(const char *message, const Args &... args)
Constructs an TimeoutException instance.
Definition: TimeoutException.hpp:46
std::shared_ptr< Exception > Ptr
The smart pointer tpye of this class.
Definition: Exception.hpp:19
ExceptionTypeId
Specifies the type id of any exception derived by <see cref="CommonException".
Definition: ExceptionTypeId.hpp:14
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:1482
Root namespace for the PLCnext API
Exception::Ptr Clone(void) const override
Clones this instance.
System components used by the System, Device, Plc or Io domains.
This is the base class of all Arp exception classes.
Definition: Exception.hpp:15