PLCnext API Documentation 25.0.2.69
Public Member Functions | Protected Member Functions | List of all members
Arp::System::Commons::ObjectDisposedException Class Reference

This exception is used when a method call is invalid for object's current state. More...

#include <ObjectDisposedException.hpp>

Inheritance diagram for Arp::System::Commons::ObjectDisposedException:
Inheritance graph

Public Member Functions

template<typename... Args>
 ObjectDisposedException (const char *message, const Args &... args)
 Constructs an ObjectDisposedException instance.
 
 ObjectDisposedException (const String &message)
 Constructs an ObjectDisposedException instance.
 
 ObjectDisposedException (String &&message)
 Constructs an ObjectDisposedException instance.
 
 ObjectDisposedException (const String &message, const Exception &innerException)
 Constructs an ObjectDisposedException instance.
 
 ObjectDisposedException (String &&message, Exception &&innerException)
 Constructs an ObjectDisposedException instance.
 
 ObjectDisposedException (const ObjectDisposedException &arg)=default
 
 ObjectDisposedException (ObjectDisposedException &&arg)=default
 
- 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
 

Protected Member Functions

Exception::Ptr Clone (void) const override
 This operation clones this instance polymorpically as a deep copy. More...
 
- Protected Member Functions inherited from Arp::System::Commons::CommonException
 CommonException (ExceptionTypeId typeId, const String &message, int skipStackTraceDepth=0)
 Constructs an CommonException instance.
 
 CommonException (ExceptionTypeId typeId, String &&message, int skipStackTraceDepth=0)
 Constructs an CommonException instance.
 
 CommonException (ExceptionTypeId typeId, const String &message, const Exception &innerException, int skipStackTraceDepth=0)
 Constructs an CommonException instance.
 
 CommonException (ExceptionTypeId typeId, String &&message, Exception &&innerException, int skipStackTraceDepth=0)
 Constructs an CommonException instance.
 
 CommonException (ExceptionTypeId typeId, String &&message, Exception::Ptr &&innerExceptionPtr, int skipStackTraceDepth=0)
 Constructs an CommonException instance.
 
 CommonException (const CommonException &arg)=default
 
 CommonException (CommonException &&arg) noexcept=default
 
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::System::Commons::CommonException
using ExceptionTypeId = Arp::ExceptionTypeId
 
- 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 used when a method call is invalid for object's current state.

Member Function Documentation

◆ Clone()

Exception::Ptr Arp::System::Commons::ObjectDisposedException::Clone ( void  ) const
overrideprotectedvirtual

This operation clones this instance polymorpically as a deep copy.

Never ever forget to override this operation in any derived exception class.

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


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