pcl::Exception Class Reference

Root base class for all PCL exception classes. More...

#include <Exception.h>

Inheritance diagram for pcl::Exception:

Public Member Functions
	Exception ()=default
	Exception (const pcl::Exception &)=default
virtual	~Exception ()
virtual String	Caption () const
virtual String	ExceptionClass () const
virtual String	FormatInfo () const
virtual String	Message () const
virtual void	Show () const
PCL_FORCE_INLINE void	ShowOnConsole () const
virtual bool	ShowUnformatted () const

Static Public Member Functions
static void	DisableConsoleOutput (bool disable=true)
static void	DisableGUIOutput (bool disable=true)
static void	EnableConsoleOutput (bool=true)
static void	EnableGUIOutput (bool=true)
static bool	IsConsoleOutputEnabled ()
static bool	IsGUIOutputEnabled ()

Detailed Description

All exceptions thrown by PCL classes and functions are descendants of the Exception class.

Definition at line 81 of file Exception.h.

Constructor & Destructor Documentation

Exception() [1/2]

pcl::Exception::Exception ( )

default

Constructs an Exception object.

Exception() [2/2]

pcl::Exception::Exception ( const pcl::Exception &  )

default

Copy constructor.

~Exception()

virtual pcl::Exception::~Exception ( )

inlinevirtual

Virtual destructor.

Definition at line 98 of file Exception.h.

Member Function Documentation

Caption()

virtual String pcl::Exception::Caption ( ) const

virtual

Returns a caption text suitable to represent the information in this Exception object.

Reimplemented in pcl::Win32Exception, pcl::UnixSignalException, pcl::FatalError, and pcl::Error.

DisableConsoleOutput()

static void pcl::Exception::DisableConsoleOutput ( bool  disable = true )

inlinestatic

Disables console output for Exception.

See also

IsConsoleOutputEnabled(), EnableConsoleOutput(), IsGUIOutputEnabled(), EnableGUIOutput()

Definition at line 208 of file Exception.h.

DisableGUIOutput()

static void pcl::Exception::DisableGUIOutput ( bool  disable = true )

inlinestatic

Disables GUI output for Exception.

See also

IsGUIOutputEnabled(), EnableGUIOutput(), IsConsoleOutputEnabled(), EnableConsoleOutput()

Definition at line 238 of file Exception.h.

EnableConsoleOutput()

static void pcl::Exception::EnableConsoleOutput ( bool  = true )

static

Enables console output for Exception.

See also

IsConsoleOutputEnabled(), DisableConsoleOutput(), IsGUIOutputEnabled(), EnableGUIOutput()

EnableGUIOutput()

static void pcl::Exception::EnableGUIOutput ( bool  = true )

static

Enables GUI output for Exception.

See also

IsGUIOutputEnabled(), DisableGUIOutput(), IsConsoleOutputEnabled(), EnableConsoleOutput()

ExceptionClass()

virtual String pcl::Exception::ExceptionClass ( ) const

inlinevirtual

Returns an error class for this exception.

Reimplemented in pcl::File::Error.

Definition at line 105 of file Exception.h.

FormatInfo()

virtual String pcl::Exception::FormatInfo ( ) const

virtual

Returns a formatted representation of the information transported by this Exception object.

Reimplemented in pcl::Win32Exception, and pcl::UnixSignalException.

IsConsoleOutputEnabled()

static bool pcl::Exception::IsConsoleOutputEnabled ( )

static

Returns true iff console text output is enabled for Exception.

When console output is enabled, exception information is presented as text on the PixInsight core application's console. Console exception output is always enabled by default.

See also

IsGUIOutputEnabled(), EnableConsoleOutput(), EnableGUIOutput()

IsGUIOutputEnabled()

static bool pcl::Exception::IsGUIOutputEnabled ( )

static

Returns true iff GUI output is enabled for Exception.

When GUI output is enabled, exception information is presented through message boxes and other modal, graphical interface elements. GUI exception output is always disabled by default.

See also

IsConsoleOutputEnabled(), EnableConsoleOutput(), EnableGUIOutput()

Message()

virtual String pcl::Exception::Message ( ) const

inlinevirtual

Returns an error or warning message corresponding to this exception.

Reimplemented in pcl::Win32Exception, pcl::UnixSignalException, pcl::File::Error, pcl::SourceCodeError, pcl::ParseError, and pcl::Error.

Definition at line 113 of file Exception.h.

Show()

virtual void pcl::Exception::Show ( ) const

virtual

Shows a representation of the information transported by this exception.

Exception information can be shown as text on the platform console or using graphical interfaces, depending on a global setting controlled with the EnableConsoleOutput() and EnableGUIOutput() static member functions.

See also

IsConsoleOutputEnabled(), IsGUIOutputEnabled()

Reimplemented in pcl::Win32Exception, pcl::UnixSignalException, pcl::SourceCodeError, and pcl::ParseError.

ShowOnConsole()

PCL_FORCE_INLINE void pcl::Exception::ShowOnConsole ( ) const

inline

Prints a representation of the information transported by this exception exclusively as plain text on the platform console.

This function ignores current settings defined through previous calls to EnableConsoleOutput() and EnableGUIOutput().

Definition at line 165 of file Exception.h.

ShowUnformatted()

virtual bool pcl::Exception::ShowUnformatted ( ) const

inlinevirtual

Returns true if the exception information must be represented verbatim on the console (when console output is enabled) without inserting any prefixes, captions, and indicators.

Derived classes can reimplement this function to prevent duplicate decorations on the console when the exception information already includes all the necessary formatting elements. For example, this happens with exceptions generated within running threads, which are already represented as formatted console text that can be retrieved using Thread::ConsoleOutputText() to write it to the Process Console interface.

Reimplemented in pcl::Error.

Definition at line 153 of file Exception.h.

---

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

• Exception.h