PLCnext API Documentation 23.6.0.37
TimeoutException.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 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
27public: // static factory methods
28 static TimeoutException Create(void);
29 static TimeoutException Create(const Exception& innerException);
30
31protected: // overridden operations
32 Exception::Ptr Clone(void)const override;
33
34private: // deleted methods
35 TimeoutException& operator=(const TimeoutException& arg) = delete;
36
37private:
38 static const char* const defaultMessage;
39};
40
42// inline methods of class TimeoutException
43
45template<typename... Args>
46inline TimeoutException::TimeoutException(const char* message, const Args& ... args)
47 : CommonException(ExceptionTypeId::Timeout, String::Format(message, args...))
48{
49}
50
54{
55}
56
59 : CommonException(ExceptionTypeId::Timeout, std::move(message))
60{
61}
62
64inline TimeoutException::TimeoutException(const String& message, const Exception& innerException)
65 : CommonException(ExceptionTypeId::Timeout, message, innerException)
66{
67}
68
70inline 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 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 timeout occurs.
Definition: TimeoutException.hpp:15
Exception::Ptr Clone(void) const override
Clones this instance.
TimeoutException(const char *message, const Args &... args)
Constructs an TimeoutException instance.
Definition: TimeoutException.hpp:46
static TimeoutException Create(void)
Creates an TimeoutException instance using a default message text.
Definition: TimeoutException.hpp:76
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
Defines some predefined timeouts.
Definition: TypeSystem.h:72