PLCnext API Documentation 25.0.2.69
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Arp::Base::Commons::Exceptions::Io::IoException Class Reference

This exception is thrown when an unspecified IO error occurs. More...

#include <IoException.hpp>

Inheritance diagram for Arp::Base::Commons::Exceptions::Io::IoException:
Inheritance graph

Public Member Functions

template<typename... Args>
 IoException (const char *message, const Args &... args)
 Creates an IoException with message. More...
 
 IoException (String &&message)
 Constructs an IoException instance. More...
 
 IoException (const String &message)
 Constructs an IoException instance. More...
 
 IoException (String &&message, const Exception &innerException)
 Constructs an IoException instance. More...
 
 IoException (const String &message, const Exception &innerException)
 Constructs an IoException instance. More...
 
 IoException (const IoException &arg)
 Default copy constructor.
 
 IoException (IoException &&arg) noexcept
 Default move constructor.
 
IoExceptionoperator= (const IoException &arg)
 Default copy-assignment operator.
 
IoExceptionoperator= (IoException &&arg) noexcept
 Default move-assignment operator.
 
 ~IoException (void) override
 Default destructor.
 
Impl & GetImpl (void)
 For internal use only.
 
const Impl & GetImpl (void) const
 
- Public Member Functions inherited from Arp::Base::Commons::Exceptions::CommonExceptionBase
const StacktraceGetStacktrace (void) const
 Gets the stackstrace of the point of creating this exception. More...
 
const StacktraceItems & GetStacktraceItems (void) const
 Gets the stackstrace items of the point of creating this exception. More...
 
- Public Member Functions inherited from Arp::Base::Core::Exception
 Exception (const Exception &arg)
 Default copy constructor.
 
 Exception (Exception &&arg) noexcept
 Default move constructor.
 
Exceptionoperator= (const Exception &arg)
 Default copy-assignment operator.
 
Exceptionoperator= (Exception &&arg) noexcept
 Default move-assignment operator.
 
virtual ~Exception (void)
 Default destructor.
 
 Exception (void)
 Constructs an empty instance of class Exception.
 
template<typename... Args>
 Exception (const char *message, Args &&... args)
 Constructs an instance of class Exception. More...
 
 Exception (const String &message)
 Constructs an instance of class Exception. More...
 
 Exception (String &&message)
 Constructs an instance of class Exception. More...
 
 Exception (const String &message, const Exception &innerException)
 Constructs an instance of class Exception. More...
 
 Exception (String &&message, const Exception &innerException)
 Constructs an instance of class Exception. More...
 
const StringGetMessage (void) const
 Gets the error message of this exception. More...
 
ExceptionTypeId GetTypeId (void) const
 Gets the type ID of this exception. More...
 
TypeCode GetTypeCode (void) const
 Gets the type code of this exception. More...
 
bool HasInnerException (void) const
 Determines if this exception has an inner exception. More...
 
const ExceptionGetInnerException (void) const
 Gets the inner exception of this exception. More...
 
String ToString (void) const
 This operation should be used for logging and returns a reasonable description of the exception cause. More...
 
virtual Exception::Ptr Clone (void) const
 This operation clones this instance polymorphically as a deep copy. More...
 
virtual String Format (bool withInnerException) const
 Formats this exception using the given indent level. More...
 
Impl & GetImpl (void)
 For internal use only.
 
const Impl & GetImpl (void) const
 

Static Public Member Functions

static IoException Create (const String &message)
 Creates an IoException using a default message. More...
 
static IoException Create (const String &message, const String &path)
 Creates an IoException using a default message. More...
 

Protected Member Functions

 IoException (ExceptionTypeId typeId, String &&message, StackCounter stackCounter)
 Creates an IoException instance, used by derived classes only. More...
 
 IoException (ExceptionTypeId typeId, const String &message, StackCounter stackCounter)
 Creates an IoException instance, used by derived classes only. More...
 
 IoException (ExceptionTypeId typeId, String &&message, const Exception &innerException, StackCounter stackCounter)
 Creates an IoException instance, used by derived classes only. More...
 
 IoException (ExceptionTypeId typeId, const String &message, const Exception &innerException, StackCounter stackCounter)
 Creates an IoException instance, used by derived classes only. More...
 
Exception::Ptr Clone (void) const override
 This operation clones this instance polymorphically as a deep copy. More...
 
- Protected Member Functions inherited from Arp::Base::Commons::Exceptions::CommonExceptionBase
 CommonExceptionBase (const CommonExceptionBase &arg)
 Default copy constructor.
 
 CommonExceptionBase (CommonExceptionBase &&arg) noexcept
 Default move constructor.
 
CommonExceptionBaseoperator= (const CommonExceptionBase &arg)
 Default copy-assignment operator.
 
CommonExceptionBaseoperator= (CommonExceptionBase &&arg) noexcept
 Default move-assignment operator.
 
 ~CommonExceptionBase (void) override
 Default destructor.
 
 CommonExceptionBase (ExceptionTypeId typeId, String &&message, StackCounter stackCounter)
 Constructs an CommonExceptionBase instance. Used by derived classes only. More...
 
 CommonExceptionBase (ExceptionTypeId typeId, const String &message, StackCounter stackCounter)
 Constructs an CommonExceptionBase instance. Used by derived classes only. More...
 
 CommonExceptionBase (ExceptionTypeId typeId, String &&message, const Exception &innerException, StackCounter stackCounter)
 Constructs an CommonExceptionBase instance. Used by derived classes only. More...
 
 CommonExceptionBase (ExceptionTypeId typeId, const String &message, const Exception &innerException, StackCounter stackCounter)
 Constructs an CommonExceptionBase instance. Used by derived classes only. More...
 
String Format (bool withInnerException) const override
 Formats this exception using the given indent level. More...
 
- Protected Member Functions inherited from Arp::Base::Core::Exception
 Exception (ExceptionTypeId typeId, String &&message)
 Used by derived exception classes. More...
 
 Exception (ExceptionTypeId typeId, const String &message)
 Used by derived exception classes. More...
 
 Exception (ExceptionTypeId typeId, String &&message, const Exception &innerException)
 Used by derived exception classes. More...
 
 Exception (ExceptionTypeId typeId, const String &message, const Exception &innerException)
 Used by derived exception classes. More...
 
 Exception (String &&message, const Exception::Ptr &innerExceptionPtr)
 DEPRECATED. More...
 
String Format (int indentLevel, bool withInnerException) const
 DEPRECATED. More...
 
virtual uint32 GetTypeCodeInternal (void) const
 DEPRECATED. More...
 

Additional Inherited Members

- Public Types inherited from Arp::Base::Commons::Exceptions::CommonExceptionBase
using StackCounter = Arp::Base::Commons::Runtime::StackCounter
 
using Stacktrace = Arp::Base::Commons::Runtime::Stacktrace
 
using StacktraceItems = Arp::Base::Commons::Runtime::Stacktrace::Items
 
- Public Types inherited from Arp::Base::Core::Exception
using Ptr = std::unique_ptr< Exception >
 The smart pointer type of this class.
 
using TypeCode = std::underlying_type< Arp::Base::Core::ExceptionTypeId >::type
 The integral type of the type code.
 

Detailed Description

This exception is thrown when an unspecified IO error occurs.

Al Io exception classes shall be derived by this class.

Constructor & Destructor Documentation

◆ IoException() [1/9]

template<typename... Args>
Arp::Base::Commons::Exceptions::Io::IoException::IoException ( const char *  message,
const Args &...  args 
)
inlineexplicit

Creates an IoException with message.

Template Parameters
...ArgsThe variadic template types.
Parameters
messageThe format message.
...argsThe arguments of the format message.

◆ IoException() [2/9]

Arp::Base::Commons::Exceptions::Io::IoException::IoException ( String &&  message)

Constructs an IoException instance.

Parameters
messageThe exception message.

◆ IoException() [3/9]

Arp::Base::Commons::Exceptions::Io::IoException::IoException ( const String message)

Constructs an IoException instance.

Parameters
messageThe exception message.

◆ IoException() [4/9]

Arp::Base::Commons::Exceptions::Io::IoException::IoException ( String &&  message,
const Exception innerException 
)

Constructs an IoException instance.

Parameters
messageThe exception message.
innerExceptionThe inner exception.

◆ IoException() [5/9]

Arp::Base::Commons::Exceptions::Io::IoException::IoException ( const String message,
const Exception innerException 
)

Constructs an IoException instance.

Parameters
messageThe exception message.
innerExceptionThe inner exception.

◆ IoException() [6/9]

Arp::Base::Commons::Exceptions::Io::IoException::IoException ( ExceptionTypeId  typeId,
String &&  message,
StackCounter  stackCounter 
)
protected

Creates an IoException instance, used by derived classes only.

Parameters
typeIdThe exception type id of the derived exception
messageThe exception message.
stackCounterThe stack counter,

◆ IoException() [7/9]

Arp::Base::Commons::Exceptions::Io::IoException::IoException ( ExceptionTypeId  typeId,
const String message,
StackCounter  stackCounter 
)
protected

Creates an IoException instance, used by derived classes only.

Parameters
typeIdThe exception type id of the derived exception
messageThe exception message.
stackCounterThe stack counter,

◆ IoException() [8/9]

Arp::Base::Commons::Exceptions::Io::IoException::IoException ( ExceptionTypeId  typeId,
String &&  message,
const Exception innerException,
StackCounter  stackCounter 
)
protected

Creates an IoException instance, used by derived classes only.

Parameters
typeIdThe exception type id of the derived exception
messageThe exception message.
innerExceptionThe inner exception.
stackCounterThe stack counter,

◆ IoException() [9/9]

Arp::Base::Commons::Exceptions::Io::IoException::IoException ( ExceptionTypeId  typeId,
const String message,
const Exception innerException,
StackCounter  stackCounter 
)
protected

Creates an IoException instance, used by derived classes only.

Parameters
typeIdThe exception type id of the derived exception
messageThe exception message.
innerExceptionThe inner exception.
stackCounterThe stack counter,

Member Function Documentation

◆ Clone()

Exception::Ptr Arp::Base::Commons::Exceptions::Io::IoException::Clone ( void  ) const
overrideprotectedvirtual

This operation clones this instance polymorphically as a deep copy.

Reimplemented from Arp::Base::Core::Exception.

Reimplemented in Arp::Base::Commons::Exceptions::Io::PathNotExistException.

◆ Create() [1/2]

IoException Arp::Base::Commons::Exceptions::Io::IoException::Create ( const String message)
static

Creates an IoException using a default message.

Parameters
messageThe exception message.
Returns
The resulting IoException.

◆ Create() [2/2]

IoException Arp::Base::Commons::Exceptions::Io::IoException::Create ( const String message,
const String path 
)
static

Creates an IoException using a default message.

Parameters
messageThe exception message.
pathThe related path.
Returns
The resulting IoException.

The documentation for this class was generated from the following files: