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