< Home

< Table of Contents

REFERENCE MANUAL

HPS.WarningEvent Class Reference

The WarningEvent class is the event that will be generated if an asynchronous warning occurs. More...

Inheritance diagram for HPS.WarningEvent:
HPS.Event

Public Member Functions

override HPS.Event Clone ()
 Allocates and returns a copy of this WarningEvent. More...
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
virtual bool Equals (HPS.WarningEvent in_that)
 Check if the source object is equivalent to this object. More...
 
override int GetHashCode ()
 
 WarningEvent ()
 The default constructor creates a WarningEvent object with an empty message and code of Unknown. More...
 
 WarningEvent (string in_message)
 This constructor creates a WarningEvent object with a specified message and code of Unknown. More...
 
 WarningEvent (string in_message, HPS.Info.Code in_code)
 This constructor creates a WarningEvent object with a specified message and code. More...
 
 WarningEvent (HPS.Event in_event)
 This constructor converts an EventObject to a WarningEvent object. More...
 
 WarningEvent (HPS.WarningEvent 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 ()
 
delegate bool EventDelegate_1 (IntPtr in_that_event)
 
delegate IntPtr EventDelegate_2 ()
 
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.WarningEvent a, HPS.WarningEvent b)
 
static bool operator== (HPS.WarningEvent a, HPS.WarningEvent 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 { Status.InProgress = 0, Status.Completed = 1, Status.Failed = 2 }
 Event Status - returned from a notifier to give the status of the event. More...
 
- Protected Attributes inherited from HPS.Event
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The WarningEvent class is the event that will be generated if an asynchronous warning occurs.

Constructor & Destructor Documentation

HPS.WarningEvent.WarningEvent ( )

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

HPS.WarningEvent.WarningEvent ( string  in_message)

This constructor creates a WarningEvent object with a specified message and code of Unknown.

Parameters
in_messageA message describing the nature of the warning.
HPS.WarningEvent.WarningEvent ( string  in_message,
HPS.Info.Code  in_code 
)

This constructor creates a WarningEvent object with a specified message and code.

Parameters
in_messageA message describing the nature of the warning.
in_codeA code describing the nature of the warning.
HPS.WarningEvent.WarningEvent ( HPS.Event  in_event)

This constructor converts an EventObject to a WarningEvent object.

Parameters
in_eventThe <ref refid="class_h_p_s_1_1_event" kindref="compound">Event</ref><ref refid="class_h_p_s_1_1_object" kindref="compound">Object</ref> to be converted.

Member Function Documentation

override HPS.Event HPS.WarningEvent.Clone ( )
virtual

Allocates and returns a copy of this WarningEvent.

Returns
A copy of this WarningEvent.

Implements HPS.Event.

virtual bool HPS.WarningEvent.Equals ( HPS.WarningEvent  in_that)
virtual

Check if the source object is equivalent to this object.

Returns
true if the objects are equivalent, false otherwise.

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