PLCnext API Documentation 25.0.2.69
InvalidFormatException.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
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 InvalidFormatException(const char* message, const Args& ... args);
19 InvalidFormatException(const String& message);
21 InvalidFormatException(const String& message, const Exception& innerException);
22 InvalidFormatException(String&& message, Exception&& innerException);
25 virtual ~InvalidFormatException(void) = default;
26
27public: // static factory methods
28 static InvalidFormatException Create(const char* formatString);
29 static InvalidFormatException Create(const char* formatString, const char* errorMessage);
30
31protected: // overridden operations
32 Exception::Ptr Clone(void)const override;
33
34private: // deleted methods
35 InvalidFormatException& operator=(const InvalidFormatException& arg) = delete;
36
37private:
38 static const char* const defaultMessage;
39 static const char* const defaultMessage2;
40};
41
43// inline methods of class InvalidFormatException
44
46template<typename... Args>
47inline InvalidFormatException::InvalidFormatException(const char* messageArg, const Args& ... args)
48 : CommonException(ExceptionTypeId::InvalidFormat, String::Format(messageArg, args...))
49{
50}
51
52}}} // end of namesapce Arp::System::Commons
53
55// template specialization of InvalidFormatException formatter
56template<> struct fmt::formatter<Arp::System::Commons::InvalidFormatException> : public fmt::ostream_formatter {};
This is the base class of all Arp exception classes.
Definition: Exception.hpp:21
std::unique_ptr< Exception > Ptr
The smart pointer type of this class.
Definition: Exception.hpp:27
This class represents the Arp String. The implementation is based on std::string.
Definition: String.hpp:39
This is the base class of common exception classes.
Definition: CommonException.hpp:18
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.cpp:46
Exception::Ptr Clone(void) const override
This operation clones this instance polymorpically as a deep copy.
Definition: InvalidFormatException.cpp:16
ExceptionTypeId
Specifies the type id of any exception derived by <see cref="CommonException".
Definition: ExceptionTypeId.hpp:15
Root namespace for the PLCnext API