Public Member Functions | Protected Member Functions | Properties | List of all members
HPS.UpdateCompletedEvent Class Reference

The UpdateCompletedEvent class is the event that is generated when an update is completed More...

Inheritance diagram for HPS.UpdateCompletedEvent:
HPS.Event

Public Member Functions

override void Dispose ()
 
 UpdateCompletedEvent ()
 The default constructor creates a UpdateCompletedEvent. More...
 
 UpdateCompletedEvent (double in_update_time)
 The constructor creates a UpdateCompletedEvent. More...
 
 UpdateCompletedEvent (HPS.Event in_event)
 This constructor converts an EventObject to an UpdateCompletedEvent object. More...
 
 UpdateCompletedEvent (HPS.UpdateCompletedEvent in_that)
 
override HPS.Event Clone ()
 Allocates and returns a copy of this UpdateCompletedEvent. More...
 
- Public Member Functions inherited from HPS.Event
IntPtr GetClassID ()
 
 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)
 
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...
 
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...
 
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...
 
delegate IntPtr EventDelegate_0 ()
 
delegate bool EventDelegate_1 (IntPtr in_that_event)
 
delegate IntPtr EventDelegate_2 ()
 
delegate void DtorDelegate (IntPtr cPtr)
 

Protected Member Functions

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

Properties

double update_time [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
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

Detailed Description

The UpdateCompletedEvent class is the event that is generated when an update is completed

Constructor & Destructor Documentation

HPS.UpdateCompletedEvent.UpdateCompletedEvent ( )
inline

The default constructor creates a UpdateCompletedEvent.

HPS.UpdateCompletedEvent.UpdateCompletedEvent ( double  in_update_time)
inline

The constructor creates a UpdateCompletedEvent.

HPS.UpdateCompletedEvent.UpdateCompletedEvent ( HPS.Event  in_event)
inline

This constructor converts an EventObject to an UpdateCompletedEvent 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.UpdateCompletedEvent.Clone ( )
inlinevirtual

Allocates and returns a copy of this UpdateCompletedEvent.

Returns
A copy of this UpdateCompletedEvent.

Implements HPS.Event.


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