PLCnext API Documentation 23.6.0.37
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Arp::System::Commons::InvalidFormatException Class Reference

This exception is thrown when an invalid format operation occurs. More...

#include <InvalidFormatException.hpp>

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

Public Member Functions

template<typename... Args>
 InvalidFormatException (const char *message, const Args &... args)
 Constructs an InvalidFormatException instance.
 
 InvalidFormatException (const String &message)
 Constructs an InvalidFormatException instance.
 
 InvalidFormatException (String &&message)
 Constructs an InvalidFormatException instance.
 
 InvalidFormatException (const String &message, const Exception &innerException)
 Constructs an InvalidFormatException instance.
 
 InvalidFormatException (String &&message, Exception &&innerException)
 Constructs an InvalidFormatException instance.
 
 InvalidFormatException (const InvalidFormatException &arg)=default
 
 InvalidFormatException (InvalidFormatException &&arg)=default
 
- Public Member Functions inherited from Arp::System::Commons::CommonException
ExceptionTypeId GetTypeId (void) const
 Returns the ExceptionTypeId of this exception. More...
 
- Public Member Functions inherited from Arp::Exception
template<typename... Args>
 Exception (const char *message, const 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, Exception &&innerException)
 Constructs an instance of class Exception. More...
 
 Exception (const Exception &arg)=default
 Constructs an instance of class Exception. More...
 
 Exception (Exception &&arg)=default
 Constructs an instance of class Exception. More...
 
virtual ~Exception (void)=default
 Destructs this instance virually.
 
uint32 GetTypeCode (void) const
 Gets the type code of this exception. More...
 
const StringGetMessage (void) const
 Gets the error message of this exception. More...
 
bool HasInnerException (void) const
 Determines if this exception has an inner exception. More...
 
Exception::Ptr GetInnerException (void) const
 Gets the inner exception of this exception. More...
 
String ToString (void) const
 Gets a reasonable string representation of this exception. More...
 

Static Public Member Functions

static InvalidFormatException Create (const char *formatString)
 Creates an InvalidFormatException instance using a default message text.
 
static InvalidFormatException Create (const char *formatString, const char *errorMessage)
 Creates an InvalidFormatException instance using a default message text.
 

Protected Member Functions

Exception::Ptr Clone (void) const override
 Clones this instance. 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 (int indentLevel, bool withInnerException) const override
 Formats this exception using the given indent level. More...
 
uint32 GetTypeCodeInternal (void) const override
 Get the type code of this exception. Must be overridden by derived classes. More...
 
- Protected Member Functions inherited from Arp::Exception
 Exception (String &&message, const Exception::Ptr &innerExceptionPtr)
 Constructs an instance of class Exception. More...
 
virtual Exception::Ptr Clone (void) const
 Clones this instance. More...
 
virtual String Format (int indentLevel, bool withInnerException) const
 Formats this exception using the given indent level. More...
 
virtual uint32 GetTypeCodeInternal (void) const
 Get the type code of this exception. Must be overridden by derived classes. More...
 

Additional Inherited Members

- Public Types inherited from Arp::Exception
typedef std::shared_ptr< ExceptionPtr
 The smart pointer tpye of this class.
 
- Static Protected Attributes inherited from Arp::Exception
static const int indentSize = 3
 The indentation size (count of blanks)
 
static const int indentChar = ' '
 The indentation character (blank)
 
static const int innerIndentChar = '-'
 The indentation character to indent inner exceptions.
 

Detailed Description

This exception is thrown when an invalid format operation occurs.

Member Function Documentation

◆ Clone()

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

Clones this instance.

Returns
A (deep) clone of this instance.

Reimplemented from Arp::Exception.


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