PLCnext API Documentation 23.6.0.37
IndexOutOfRangeException.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 IndexOutOfRangeException(const char* message, const Args& ... args);
19 IndexOutOfRangeException(const String& message);
21 IndexOutOfRangeException(const String& message, const Exception& innerException);
22 IndexOutOfRangeException(String&& message, Exception&& innerException);
25 virtual ~IndexOutOfRangeException(void) = default;
26
27protected: // overridden operations
28 Exception::Ptr Clone(void)const override;
29
30private: // deleted methods
31 IndexOutOfRangeException& operator=(const IndexOutOfRangeException& arg) = delete;
32};
33
35// inline methods of class IndexOutOfRangeException
36
38template<typename... Args>
39inline IndexOutOfRangeException::IndexOutOfRangeException(const char* message, const Args& ... args)
40 : CommonException(ExceptionTypeId::IndexOutOfRange, String::Format(message, args...))
41{
42}
43
46 : CommonException(ExceptionTypeId::IndexOutOfRange, message)
47{
48}
49
52 : CommonException(ExceptionTypeId::IndexOutOfRange, std::move(message))
53{
54}
55
57inline IndexOutOfRangeException::IndexOutOfRangeException(const String& message, const Exception& innerException)
58 : CommonException(ExceptionTypeId::IndexOutOfRange, message, innerException)
59{
60}
61
64 : CommonException(ExceptionTypeId::IndexOutOfRange, std::move(message), std::move(innerException))
65{
66}
67
68}}} // 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 an index is out of range.
Definition: IndexOutOfRangeException.hpp:15
Exception::Ptr Clone(void) const override
Clones this instance.
IndexOutOfRangeException(const char *message, const Args &... args)
Constructs an IndexOutOfRangeException instance.
Definition: IndexOutOfRangeException.hpp:39
@ 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