PLCnext API Documentation  22.9.0.33
InvalidFormatException.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  InvalidFormatException(const char* message, const Args& ... args);
19  InvalidFormatException(const String& message);
20  InvalidFormatException(String&& message);
21  InvalidFormatException(const String& message, const Exception& innerException);
22  InvalidFormatException(String&& message, Exception&& innerException);
23  InvalidFormatException(const InvalidFormatException& arg) = default;
25  virtual ~InvalidFormatException(void) = default;
26 
27 public: // static factory methods
28  static InvalidFormatException Create(const char* formatString);
29  static InvalidFormatException Create(const char* formatString, const char* errorMessage);
30 
31 protected: // overridden operations
32  Exception::Ptr Clone(void)const override;
33 
34 private: // deleted methods
35  InvalidFormatException& operator=(const InvalidFormatException& arg) = delete;
36 
37 private:
38  static const char* const defaultMessage;
39  static const char* const defaultMessage2;
40 };
41 
43 // inline methods of class InvalidFormatException
44 
46 template<typename... Args>
47 inline InvalidFormatException::InvalidFormatException(const char* messageArg, const Args& ... args)
48  : CommonException(ExceptionTypeId::InvalidFormat, String::Format(messageArg, args...))
49 {
50 }
51 
54  : CommonException(ExceptionTypeId::InvalidFormat, messageArg)
55 {
56 }
57 
60  : CommonException(ExceptionTypeId::InvalidFormat, std::move(messageArg))
61 {
62 }
63 
65 inline InvalidFormatException::InvalidFormatException(const String& messageArg, const Exception& innerException)
66  : CommonException(ExceptionTypeId::InvalidFormat, messageArg, innerException)
67 {
68 }
69 
71 inline InvalidFormatException::InvalidFormatException(String&& messageArg, Exception&& innerException)
72  : CommonException(ExceptionTypeId::InvalidFormat, std::move(messageArg), std::move(innerException))
73 {
74 }
75 
78 {
79  return InvalidFormatException(defaultMessage, formatString);
80 }
81 
83 inline InvalidFormatException InvalidFormatException::Create(const char* formatString, const char* errorMessage)
84 {
85  return InvalidFormatException(String::Format(defaultMessage2, formatString, errorMessage));
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 thrown when an invalid format operation occurs.
Definition: InvalidFormatException.hpp:15
InvalidFormatException(const char *message, const Args &... args)
Constructs an InvalidFormatException instance.
Definition: InvalidFormatException.hpp:47
static InvalidFormatException Create(const char *formatString)
Creates an InvalidFormatException instance using a default message text.
Definition: InvalidFormatException.hpp:77
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:1483
@ 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