API Documentation
Loading...
Searching...
No Matches
FileException Class Reference

An Exception that contains information about a runtime error with a particular File. This is typically thrown when an action with a file causes an error to occur within the NDEVR API. More...

#include <Exception.h>

Inheritance diagram for FileException:
[legend]
Collaboration diagram for FileException:
[legend]

Public Types

enum  ExceptionType {
  e_generic , e_no_open , e_already_open , e_does_not_exist ,
  e_file_exits , e_file_invalid , e_checksum_failed , e_not_supported ,
  e_no_create
}
 

Public Member Functions

 FileException (const File &file, const TranslatedString &message, ExceptionType type=e_generic)
 
 FileException (const File &file, ExceptionType type=e_generic)
 
const FilegetFile () const
 
ExceptionType getType () const
 
- Public Member Functions inherited from Exception
 Exception (const std::exception &exception)
 
 Exception (const String &title, const bool &capture_stack=true)
 
 Exception (const TranslatedString &title, const bool &capture_stack=true)
 
 Exception (const TranslatedString &title, const TranslatedString &message, const bool &capture_stack=true)
 
virtual const TranslatedStringgetCategory () const
 
virtual TranslatedString getMessage () const
 
virtual uint04 getPriority () const
 
virtual const TranslatedStringgetTitle () const
 
UUID id () const
 
void printToLogger ()
 
void setCategory (const TranslatedString &category)
 
virtual void setMessage (const TranslatedString &message)
 
void setThread (const String &thread)
 
void setTitle (const TranslatedString &title)
 
virtual const StringstackTrace () const
 
const Stringthread () const
 
virtual ~Exception ()=default
 

Additional Inherited Members

- Protected Attributes inherited from Exception
TranslatedString m_category
 
TranslatedString m_message
 
uint04 m_priority
 
String m_stack_trace
 
String m_thread
 
TranslatedString m_title
 

Detailed Description

An Exception that contains information about a runtime error with a particular File. This is typically thrown when an action with a file causes an error to occur within the NDEVR API.


Member Enumeration Documentation

◆ ExceptionType

Enumerator
e_generic 
e_no_open 
e_already_open 
e_does_not_exist 
e_file_exits 
e_file_invalid 
e_checksum_failed 
e_not_supported 
e_no_create 

Constructor & Destructor Documentation

◆ FileException() [1/2]

FileException ( const File & file,
ExceptionType type = e_generic )
explicit

◆ FileException() [2/2]

FileException ( const File & file,
const TranslatedString & message,
ExceptionType type = e_generic )

Member Function Documentation

◆ getFile()

const File & getFile ( ) const
inline

◆ getType()

ExceptionType getType ( ) const
inline

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