ErrorEvent
-
class HPS::ErrorEvent : public HPS::Event
The ErrorEvent class is the event that will be generated if an asynchronous error occurs.
Public Functions
-
inline virtual Event *Clone() const
Allocates and returns a copy of this ErrorEvent.
- Returns
A copy of this ErrorEvent.
-
inline virtual bool Equals(ErrorEvent const &in_that) const
Check if the source object is equivalent to this object.
- Parameters
in_kit – The source object to compare to this object.
- Returns
true if the objects are equivalent, false otherwise.
-
inline ErrorEvent()
The default constructor creates an ErrorEvent object with an empty message and code of Unknown.
-
ErrorEvent(char const *in_message)
This constructor creates an ErrorEvent object with a specified message and code of Unknown.
- Parameters
in_message – A message describing the nature of the error.
-
ErrorEvent(char const *in_message, HPS::Info::Code in_code)
This constructor creates a ErrorEvent object with a specified message and code.
- Parameters
in_message – A message describing the nature of the error.
in_code – A code describing the nature of the error.
-
inline ErrorEvent(Event const &in_event)
This constructor converts an Event Object to an ErrorEvent object.
-
inline virtual bool operator!=(ErrorEvent const &in_that) const
Check if the source object is not equivalent to this object.
- Parameters
in_that – The source object to compare to this object.
- Returns
true if the objects are not equivalent, false otherwise.
-
inline virtual bool operator==(ErrorEvent const &in_that) const
Check if the source object is equivalent to this object.
- Parameters
in_that – The source object to compare to this object.
- Returns
true if the objects are equivalent, false otherwise.
-
~ErrorEvent()
Public Members
-
HPS::Info::Code code
The error code for this ErrorEvent.
-
UTF8 message
The error message for this ErrorEvent.
-
inline virtual Event *Clone() const
