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

#include <hps.h>

Inheritance diagram for HPS::InformationEvent:

Collaboration diagram for HPS::InformationEvent:

Public Types
enum	Status : uint32_t { Status::InProgress, Status::Completed, Status::Failed }
	Event Status - returned from a notifier to give the status of the event. More...

Public Member Functions
	InformationEvent ()
	The default constructor creates a InformationEvent object with an empty message and code of Unknown. More...

	InformationEvent (char const *in_message)
	This constructor creates a InformationEvent object with a specified information and code of Unknown. More...

	InformationEvent (char const *in_message, HPS::Info::Code in_code)
	This constructor creates a InformationEvent object with a specified information and code. More...

	InformationEvent (Event const &in_event)
	This constructor converts an Event Object to a InformationEvent object. More...

	~InformationEvent ()

Event *	Clone () const
	Allocates and returns a copy of this InformationEvent. More...

virtual bool	Equals (InformationEvent const &in_that) const
	Check if the source object is equivalent to this object. More...

virtual bool	operator== (InformationEvent const &in_that) const
	Check if the source object is equivalent to this object. More...

virtual bool	operator!= (InformationEvent const &in_that) const
	Check if the source object is not equivalent to this object. More...

intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...

virtual bool	Drop (Event const *in_that_event) const
	This optional function is used to determine if the current event can be dropped based on the following event in the queue. More...

virtual intptr_t	Freshen () const
	This optional function is used to determine if the current event can be dropped in favor of newer event of the same type if one is available. More...

intptr_t	GetChannel () const
	Returns the channel ID assigned to an event. More...

Time	GetTimeStamp () const
	Returns the time an event was injected into the event queue. More...

bool	IsConsumable () const
	Indicates whether an event will be consumed when it is handled or passed on to the next handler anyway. More...

Static Public Member Functions
static void *	operator new (size_t in_size)

static void	operator delete (void *in_ptr, size_t in_size) throw ()

Public Attributes
UTF8	message
	The warning information for this WarningEvent. More...

HPS::Info::Code	code
	The warning code for this InformationEvent. More...

Protected Attributes
intptr_t	channel

bool	consumable

Detailed Description

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

Member Enumeration Documentation

◆ Status

enum HPS::Event::Status : uint32_t

stronginherited

Event Status - returned from a notifier to give the status of the event.

Enumerator
InProgress	Event is still in progress.
Completed	Event has completed.
Failed	Event failed.

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_message A 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_message	A message describing the nature of the information.
in_code	A 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_event The Event Object to be converted.

Here is the call graph for this function:

◆ ~InformationEvent()

HPS::InformationEvent::~InformationEvent ( )

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.

◆ Drop()

virtual bool HPS::Event::Drop ( Event const * in_that_event ) const

inlinevirtualinherited

This optional function is used to determine if the current event can be dropped based on the following event in the queue.

Reimplemented in HPS::MouseEvent, HPS::TouchEvent, HPS::TimerTickEvent, HPS::SmoothTransitionCompleteEvent, and HPS::CameraChangedEvent.

◆ Equals()

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

inlinevirtual

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.

◆ Freshen()

virtual intptr_t HPS::Event::Freshen ( ) const

inlinevirtualinherited

This optional function is used to determine if the current event can be dropped in favor of newer event of the same type if one is available.

Returns: A cookie representing the freshen category. Zero indicates a non-freshening event.

Reimplemented in HPS::MouseEvent, HPS::TimerTickEvent, and HPS::CameraChangedEvent.

◆ GetChannel()

intptr_t HPS::Event::GetChannel ( ) const

inlineinherited

Returns the channel ID assigned to an event.

Here is the caller graph for this function:

◆ GetClassID()

intptr_t HPS::Event::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Here is the caller graph for this function:

◆ GetTimeStamp()

Time HPS::Event::GetTimeStamp ( ) const

inlineinherited

Returns the time an event was injected into the event queue.

◆ IsConsumable()

bool HPS::Event::IsConsumable ( ) const

inlineinherited

Indicates whether an event will be consumed when it is handled or passed on to the next handler anyway.

◆ operator delete()

static void HPS::Event::operator delete	(	void *	in_ptr,
		size_t	in_size
	)
throw	(
	)

inlinestaticinherited

Here is the call graph for this function:

◆ operator new()

static void* HPS::Event::operator new ( size_t in_size )

inlinestaticinherited

Here is the call graph for this function:

◆ 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_that The 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_that The source object to compare to this object.

Returns: true if the objects are equivalent, false otherwise.

Member Data Documentation

◆ channel

intptr_t HPS::Event::channel

protectedinherited

◆ code

HPS::Info::Code HPS::InformationEvent::code

The warning code for this InformationEvent.

◆ consumable

bool HPS::Event::consumable

protectedinherited

◆ message

UTF8 HPS::InformationEvent::message

The warning information for this WarningEvent.

The documentation for this class was generated from the following file:

hps.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ Status

Constructor & Destructor Documentation

◆ InformationEvent() [1/4]

◆ InformationEvent() [2/4]

◆ InformationEvent() [3/4]

◆ InformationEvent() [4/4]

◆ ~InformationEvent()

Member Function Documentation

◆ Clone()

◆ Drop()

◆ Equals()

◆ Freshen()

◆ GetChannel()

◆ GetClassID()

◆ GetTimeStamp()

◆ IsConsumable()

◆ operator delete()

◆ operator new()

◆ operator!=()

◆ operator==()

Member Data Documentation

◆ channel

◆ code

◆ consumable

◆ message