#include <hps.h>

Public Member Functions | |
Event * | Clone () const |
virtual bool | Equals (WarningEvent const &in_that) const |
virtual bool | operator!= (WarningEvent const &in_that) const |
virtual bool | operator== (WarningEvent const &in_that) const |
WarningEvent () | |
WarningEvent (char const *in_message) | |
WarningEvent (char const *in_message, HPS::Info::Code in_code) | |
WarningEvent (Event const &in_event) | |
![]() | |
virtual bool | Drop (Event const *in_that_event) const |
Event (intptr_t in_channel=0) | |
virtual intptr_t | Freshen () const |
intptr_t | GetChannel () const |
intptr_t | GetClassID () const |
Time | GetTimeStamp () const |
bool | IsConsumable () const |
Public Attributes | |
HPS::Info::Code | code |
The warning code for this WarningEvent. | |
UTF8 | message |
The warning message for this WarningEvent. | |
Additional Inherited Members | |
![]() | |
enum | Status : uint32_t { Status::InProgress, Status::Completed, Status::Failed } |
![]() | |
static void | operator delete (void *in_ptr, size_t in_size) throw () |
static void * | operator new (size_t in_size) |
![]() | |
intptr_t | channel |
bool | consumable |
Detailed Description
The WarningEvent class is the event that will be generated if an asynchronous warning occurs.
Constructor & Destructor Documentation
|
inline |
The default constructor creates a WarningEvent object with an empty message and code of Unknown.
HPS::WarningEvent::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.
HPS::WarningEvent::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 |
This constructor converts an Event Object to a WarningEvent object.
Member Function Documentation
|
inlinevirtual |
Allocates and returns a copy of this WarningEvent.
- Returns
- A copy of this WarningEvent.
Implements HPS::Event.
|
inlinevirtual |
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.
|
inlinevirtual |
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.
|
inlinevirtual |
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.
The documentation for this class was generated from the following file:
- include/hps.h