PCL
pcl::XMLParseError Class Reference

XML parsing error with automatic text location information generation More...

#include <XML.h>

+ Inheritance diagram for pcl::XMLParseError:

Public Member Functions

 XMLParseError (const XMLNode &node, const String &whileDoing, const String &whatHappened)
 
 XMLParseError (const XMLNodeLocation &where, const String &whileDoing, const String &whatHappened)
 
 XMLParseError (const XMLParseError &)=default
 
- Public Member Functions inherited from pcl::Error
 Error ()=default
 
 Error (const Error &)=default
 
 Error (const String &message)
 
String Caption () const override
 
String Message () const override
 
- Public Member Functions inherited from pcl::Exception
 Exception ()=default
 
 Exception (const pcl::Exception &)=default
 
virtual ~Exception ()
 
virtual String ExceptionClass () const
 
virtual String FormatInfo () const
 
virtual void Show () const
 

Additional Inherited Members

- Static Public Member Functions inherited from pcl::Exception
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

The XMLParseError is useful to generate warning and error messages during document parsing tasks, with automatic generation of text location information (when available) and a normalized representation of error messages.

Definition at line 656 of file XML.h.

Constructor & Destructor Documentation

◆ XMLParseError() [1/3]

pcl::XMLParseError::XMLParseError ( const XMLNode node,
const String whileDoing,
const String whatHappened 
)
inline

Constructs an XMLParseError object with a reference to an XMLNode instance.

Parameters
nodeReference to the XMLNode object that has caused the exception.
whileDoingIdentifies the parsing action that was taking place. For example: "Parsing Metadata child Image element".
whatHappenedDescribes the error that has been detected. For example: "Missing id attribute".

This constructor inserts node location information, if available, and joins the strings appropriately to build an error message.

Definition at line 676 of file XML.h.

◆ XMLParseError() [2/3]

pcl::XMLParseError::XMLParseError ( const XMLNodeLocation where,
const String whileDoing,
const String whatHappened 
)
inline

Constructs an XMLParseError object with a reference to an XMLNodeLocation instance.

Parameters
whereReference to an XMLNodeLocation object to retrieve text location information.
whileDoingIdentifies the parsing action that was taking place. For example: "Parsing Metadata child Image element".
whatHappenedDescribes the error that has been detected. For example: "Missing id attribute".

This constructor inserts node location information, if available, and joins the strings appropriately to build an error message.

Definition at line 697 of file XML.h.

◆ XMLParseError() [3/3]

pcl::XMLParseError::XMLParseError ( const XMLParseError )
default

Copy constructor.


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