HPS::InformationEvent Class Reference

#include <hps.h>

Inheritance diagram for HPS::InformationEvent:
HPS::Event

Public Member Functions

EventClone () const
 
virtual bool Equals (InformationEvent const &in_that) const
 
 InformationEvent ()
 
 InformationEvent (char const *in_message)
 
 InformationEvent (char const *in_message, HPS::Info::Code in_code)
 
 InformationEvent (Event const &in_event)
 
virtual bool operator!= (InformationEvent const &in_that) const
 
virtual bool operator== (InformationEvent const &in_that) const
 
- Public Member Functions inherited from HPS::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 InformationEvent.
 
UTF8 message
 The warning information for this WarningEvent.
 

Additional Inherited Members

- Public Types inherited from HPS::Event
enum  Status : uint32_t { Status::InProgress, Status::Completed, Status::Failed }
 
- Static Public Member Functions inherited from HPS::Event
static void operator delete (void *in_ptr, size_t in_size) throw ()
 
static void * operator new (size_t in_size)
 
- Protected Attributes inherited from HPS::Event
intptr_t channel
 
bool consumable
 

Detailed Description

The InformationEvent class is the event that will be generated if an asynchronous informational message occurs.

Constructor & Destructor Documentation

◆ InformationEvent() [1/4]

HPS::InformationEvent::InformationEvent ( )
inline

The default constructor creates a InformationEvent object with an empty message and code of Unknown.

◆ InformationEvent() [2/4]

HPS::InformationEvent::InformationEvent ( char const *  in_message)

This constructor creates a InformationEvent object with a specified information and code of Unknown.

Parameters
in_messageA message describing the nature of the information.

◆ InformationEvent() [3/4]

HPS::InformationEvent::InformationEvent ( char const *  in_message,
HPS::Info::Code  in_code 
)

This constructor creates a InformationEvent object with a specified information and code.

Parameters
in_messageA message describing the nature of the information.
in_codeA code describing the nature of the information.

◆ InformationEvent() [4/4]

HPS::InformationEvent::InformationEvent ( Event const &  in_event)
inline

This constructor converts an Event Object to a InformationEvent object.

Parameters
in_eventThe Event Object to be converted.

Member Function Documentation

◆ Clone()

Event* HPS::InformationEvent::Clone ( ) const
inlinevirtual

Allocates and returns a copy of this InformationEvent.

Returns
A copy of this InformationEvent.

Implements HPS::Event.

◆ Equals()

virtual bool HPS::InformationEvent::Equals ( InformationEvent const &  in_that) const
inlinevirtual

Check if the source object is equivalent to this object.

Parameters
in_thatThe source object to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ operator!=()

virtual bool HPS::InformationEvent::operator!= ( InformationEvent const &  in_that) const
inlinevirtual

Check if the source object is not equivalent to this object.

Parameters
in_thatThe source object to compare to this object.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator==()

virtual bool HPS::InformationEvent::operator== ( InformationEvent const &  in_that) const
inlinevirtual

Check if the source object is equivalent to this object.

Parameters
in_thatThe 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: