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