HPS.UpdateCompletedEvent Class Reference
Inheritance diagram for HPS.UpdateCompletedEvent:
HPS.Event

Public Member Functions

override HPS.Event Clone ()
 
override void Dispose ()
 
 UpdateCompletedEvent ()
 
 UpdateCompletedEvent (double in_update_time, HPS.Window.UpdateStatus in_update_status)
 
 UpdateCompletedEvent (HPS.Event in_event)
 
 UpdateCompletedEvent (HPS.UpdateCompletedEvent in_that)
 
- Public Member Functions inherited from HPS.Event
virtual bool Drop (HPS.Event in_that_event)
 
delegate void DtorDelegate (IntPtr cPtr)
 
 Event (IntPtr in_channel)
 
 Event ()
 
 Event (HPS.Event in_that)
 
virtual IntPtr Freshen ()
 
IntPtr GetChannel ()
 
IntPtr GetClassID ()
 
double GetTimeStamp ()
 
bool IsConsumable ()
 

Protected Member Functions

override void deleteCptr ()
 
override bool DerivedClassHasMethod (string methodName, System.Type[] methodTypes)
 
override IntPtr GetNonDirectorClassID ()
 
override bool IsUserDerived ()
 

Properties

HPS.Window.UpdateStatus update_status [get, set]
 
double update_time [get, set]
 

Additional Inherited Members

- Public Types inherited from HPS.Event
enum  Status : uint { Status.InProgress = 0x00000000, Status.Completed = 0x00000001, Status.Failed = 0x00000002 }
 
- Static Protected Member Functions inherited from HPS.Event
static void DtorCallback (IntPtr p)
 
- Protected Attributes inherited from HPS.Event
bool cMemOwn
 
HandleRef cptr
 
- Static Protected Attributes inherited from HPS.Event
static Dictionary< IntPtr, EventcachedObjects = new Dictionary<IntPtr, Event>()
 
static ReaderWriterLockSlim mapLock = new ReaderWriterLockSlim(LockRecursionPolicy.SupportsRecursion)
 

Detailed Description

The UpdateCompletedEvent class is the event that is generated when an update is completed Note: Updates happen on a per-WindowKey basis, therefore, EventHandler objects which handle UpdateCompletedEvents need to be subscribed to the EventDispatcher of the WindowKey whose update needs to be monitored. Example: myWindow.GetEventDspatcher().Subscribe(*my_handler, HPS.Object.ClassID<HPS.UpdateCompletedEvent>());

Constructor & Destructor Documentation

◆ UpdateCompletedEvent() [1/3]

HPS.UpdateCompletedEvent.UpdateCompletedEvent ( )
inline

The default constructor creates a UpdateCompletedEvent.

◆ UpdateCompletedEvent() [2/3]

HPS.UpdateCompletedEvent.UpdateCompletedEvent ( double  in_update_time,
HPS.Window.UpdateStatus  in_update_status 
)
inline

The constructor creates a UpdateCompletedEvent.

◆ UpdateCompletedEvent() [3/3]

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

This constructor converts an EventObject to an UpdateCompletedEvent object.

Parameters
in_eventThe EventObject to be converted.

Member Function Documentation

◆ Clone()

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:
  • internals/hps_core/source/cs/HPS.UpdateCompletedEvent.cs