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

Inheritance diagram for HPS.InformationEvent:
HPS.Event

Public Member Functions

override HPS.Event Clone ()
 Allocates and returns a copy of this InformationEvent. More...
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
virtual bool Equals (HPS.InformationEvent in_that)
 Check if the source object is equivalent to this object. More...
 
override int GetHashCode ()
 
 InformationEvent ()
 The default constructor creates a InformationEvent object with an empty message and code of Unknown. More...
 
 InformationEvent (string in_message)
 This constructor creates a InformationEvent object with a specified information and code of Unknown. More...
 
 InformationEvent (string in_message, HPS.Info.Code in_code)
 This constructor creates a InformationEvent object with a specified information and code. More...
 
 InformationEvent (HPS.Event in_event)
 This constructor converts an EventObject to a InformationEvent object. More...
 
 InformationEvent (HPS.InformationEvent in_that)
 
- Public Member Functions inherited from HPS.Event
virtual bool Drop (HPS.Event in_that_event)
 This optional function is used to determine if the current event can be dropped based on the following event in the queue. More...
 
delegate void DtorDelegate (IntPtr cPtr)
 
 Event (IntPtr in_channel)
 A constructor for generating events from built-in or custom event ID's. More...
 
 Event ()
 A constructor for generating events from built-in or custom event ID's. More...
 
 Event (HPS.Event in_that)
 
delegate IntPtr EventDelegate_0 (IntPtr cPtr)
 
delegate bool EventDelegate_1 (IntPtr cPtr, IntPtr in_that_event)
 
delegate IntPtr EventDelegate_2 (IntPtr cPtr)
 
virtual IntPtr Freshen ()
 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 GetChannel ()
 Returns the channel ID assigned to an event. More...
 
IntPtr GetClassID ()
 
double GetTimeStamp ()
 Returns the time an event was injected into the event queue. More...
 
bool IsConsumable ()
 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 bool operator!= (HPS.InformationEvent a, HPS.InformationEvent b)
 
static bool operator== (HPS.InformationEvent a, HPS.InformationEvent b)
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Event
void DtorCallback (IntPtr p)
 
virtual IntPtr GetNonDirectorClassID ()
 

Properties

HPS.Info.Code code [get, set]
 
string message [get, set]
 

Additional Inherited Members

- Public Types inherited from HPS.Event
enum  Status : uint { Status.InProgress = 0x00000000, Status.Completed = 0x00000001, Status.Failed = 0x00000002 }
 Event Status - returned from a notifier to give the status of the event. More...
 
- Protected Attributes inherited from HPS.Event
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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

Constructor & Destructor Documentation

HPS.InformationEvent.InformationEvent ( )
inline

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

HPS.InformationEvent.InformationEvent ( string  in_message)
inline

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

Parameters
in_messageA message describing the nature of the information.
HPS.InformationEvent.InformationEvent ( string  in_message,
HPS.Info.Code  in_code 
)
inline

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.
HPS.InformationEvent.InformationEvent ( HPS.Event  in_event)
inline

This constructor converts an EventObject to a InformationEvent object.

Parameters
in_eventThe EventObject to be converted.

Member Function Documentation

override HPS.Event HPS.InformationEvent.Clone ( )
inlinevirtual

Allocates and returns a copy of this InformationEvent.

Returns
A copy of this InformationEvent.

Implements HPS.Event.

virtual bool HPS.InformationEvent.Equals ( HPS.InformationEvent  in_that)
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:
  • internals/hps_core/source/cs/HPS.InformationEvent.cs