PLCnext API Documentation  21.0.0.35466
InvalidConfigException.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  InvalidConfigException(const char* message, const Args& ... args);
19  InvalidConfigException(const String& message);
20  InvalidConfigException(String&& message);
21  InvalidConfigException(const String& message, const Exception& innerException);
22  InvalidConfigException(String&& message, Exception&& innerException);
23  InvalidConfigException(const InvalidConfigException& arg) = default;
24  InvalidConfigException(InvalidConfigException&& arg) = default;
25  virtual ~InvalidConfigException(void) = default;
26 
27 public: // static factory methods
28  static InvalidConfigException Create(const char* configName);
29  static InvalidConfigException Create(const char* configName, const Exception& innerException);
30 
31 protected: // overridden operations
32  Exception::Ptr Clone(void)const override;
33 
34 private: // deleted methods
35  InvalidConfigException& operator=(const InvalidConfigException& arg) = delete;
36 
37 private:
38  static const char* const defaultMessage;
39 };
40 
42 // inline methods of class InvalidConfigException
43 
44 
46 template<typename... Args>
47 inline InvalidConfigException::InvalidConfigException(const char* message, const Args& ... args)
48  : CommonException(ExceptionTypeId::InvalidConfig, String::Format(message, args...))
49 {
50 }
51 
54  : CommonException(ExceptionTypeId::InvalidConfig, message)
55 {
56 }
57 
60  : CommonException(ExceptionTypeId::InvalidConfig, std::move(message))
61 {
62 }
63 
65 inline InvalidConfigException::InvalidConfigException(const String& message, const Exception& innerException)
66  : CommonException(ExceptionTypeId::InvalidConfig, message, innerException)
67 {
68 }
69 
72  : CommonException(ExceptionTypeId::InvalidConfig, std::move(message), std::move(innerException))
73 {
74 }
75 
78 {
79  return InvalidConfigException(defaultMessage, configName);
80 }
81 
83 inline InvalidConfigException InvalidConfigException::Create(const char* configName, const Exception& innerException)
84 {
85  return InvalidConfigException(String::Format(defaultMessage, configName), innerException);
86 }
87 
88 }}} // 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 method is not implemented yet.
Definition: InvalidConfigException.hpp:14
String Format(int indentLevel, bool withInnerException) const override
Formats this exception using the given indent level.
Namespace of the C++ standard library
Exception::Ptr Clone(void) const override
Clones this instance.
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
InvalidConfigException(const char *message, const Args &... args)
Constructs an InvalidConfigException instance.
Definition: InvalidConfigException.hpp:47
Root namespace for the PLCnext API
static InvalidConfigException Create(const char *configName)
Creates an InvalidConfigException instance using a default message text.
Definition: InvalidConfigException.hpp:77
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