PLCnext API Documentation  21.0.0.35466
InvalidPathException.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/Io/IoException.hpp"
9 
10 namespace Arp { namespace System { namespace Commons { namespace Io
11 {
12 
15 {
16 public: // construction/destruction
17  template<typename... Args>
18  InvalidPathException(const char* message, const Args& ... args);
19  InvalidPathException(const String& message);
20  InvalidPathException(String&& message);
21  InvalidPathException(const String& message, const Exception& innerException);
22  InvalidPathException(String&& message, Exception&& innerException);
23  InvalidPathException(const InvalidPathException& arg) = default;
24  InvalidPathException(InvalidPathException&& arg) = default;
25  virtual ~InvalidPathException(void) = default;
26 
27 public: // static factory methods
28  static InvalidPathException Create(const String& path);
29  static InvalidPathException Create(const String& path, const Exception& innerException);
30  static InvalidPathException Create(const String& sourcePath, const String& destinationPath);
31  static InvalidPathException Create(const String& sourcePath, const String& destinationPath, const Exception& innerException);
32 
33 protected: // overridden operations
34  Exception::Ptr Clone(void)const override;
35 
36 private: // deleted methods
37  InvalidPathException& operator=(const InvalidPathException& arg) = delete;
38 
39 private:
40  static const char* const defaultMessage;
41  static const char* const defaultMessage2;
42 };
43 
45 // inline methods of class InvalidPathException
46 
48 template<typename... Args>
49 inline InvalidPathException::InvalidPathException(const char* message, const Args& ... args)
50  : IoException(ExceptionTypeId::IoInvalidPath, String::Format(message, args...))
51 {
52 }
53 
56  : IoException(ExceptionTypeId::IoInvalidPath, message)
57 {
58 }
59 
62  : IoException(ExceptionTypeId::IoInvalidPath, std::move(message))
63 {
64 }
65 
67 inline InvalidPathException::InvalidPathException(const String& message, const Exception& innerException)
68  : IoException(ExceptionTypeId::IoInvalidPath, message, innerException)
69 {
70 }
71 
73 inline InvalidPathException::InvalidPathException(String&& message, Exception&& innerException)
74  : IoException(ExceptionTypeId::IoInvalidPath, std::move(message), std::move(innerException))
75 {
76 }
77 
80 {
81  return InvalidPathException(String::Format(defaultMessage, path));
82 }
83 
85 inline InvalidPathException InvalidPathException::Create(const String& path, const Exception& innerException)
86 {
87  return InvalidPathException(String::Format(defaultMessage, path), innerException);
88 }
89 
91 inline InvalidPathException InvalidPathException::Create(const String& sourcePath, const String& destinationPath)
92 {
93  return InvalidPathException(String::Format(defaultMessage2, sourcePath, destinationPath));
94 }
95 
97 inline InvalidPathException InvalidPathException::Create(const String& sourcePath, const String& destinationPath, const Exception& innerException)
98 {
99  return InvalidPathException(String::Format(defaultMessage2, sourcePath, destinationPath), innerException);
100 }
101 
102 }}}} // end of namesapce Arp::System::Commons::Io
Exception::Ptr Clone(void) const override
Clones this instance.
String Format(int indentLevel, bool withInnerException) const override
Formats this exception using the given indent level.
Namespace of the C++ standard library
This is the base class of all IO exceptions.
Definition: IoException.hpp:14
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 InvalidPathException Create(const String &path)
Creates an InvalidPathException instance using a default message text.
Definition: InvalidPathException.hpp:79
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
InvalidPathException(const char *message, const Args &... args)
Constructs an InvalidPathException instance.
Definition: InvalidPathException.hpp:49
Root namespace for the PLCnext API
This exception is used when a requested file does not exist.
Definition: InvalidPathException.hpp:14
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