HPS.UpdateNotifier Class Reference

Inheritance diagram for HPS.UpdateNotifier:

Public Member Functions
void	Assign (HPS.UpdateNotifier in_that)
HPS.UpdateNotifier	Cancel ()
override void	Dispose ()
override HPS.Type	ObjectType ()
HPS.Window.UpdateStatus	Status ()
	UpdateNotifier (HPS.UpdateNotifier in_that)
HPS.UpdateNotifier	Wait ()
Public Member Functions inherited from HPS.Object
virtual bool	Empty ()
IntPtr	GetClassID ()
IntPtr	GetInstanceID ()
bool	HasType (HPS.Type in_mask)
	Object (HPS.Object that)
virtual void	Reset ()
virtual HPS.Type	Type ()

Protected Member Functions
override void	deleteCptr ()
Protected Member Functions inherited from HPS.Object
virtual IntPtr	GetNonDirectorClassID ()

Additional Inherited Members
Static Public Member Functions inherited from HPS.Object
static IntPtr	ClassID< T > ()
Protected Attributes inherited from HPS.Object
bool	cMemOwn
HandleRef	cptr

Detailed Description

The UpdateNotifier class is a smart pointer that is associated with a window update. It is a special type of control that is used for synchronizing with a window update status.

Constructor & Destructor Documentation

UpdateNotifier()

HPS.UpdateNotifier.UpdateNotifier ( HPS.UpdateNotifier  in_that )

inline

The move constructor creates an UpdateNotifier by transferring the underlying impl of the rvalue reference to this UpdateNotifier thereby avoiding a copy and allocation.

Parameters

in_that

An rvalue reference to an UpdateNotifier to take the impl from.

Member Function Documentation

Assign()

void HPS.UpdateNotifier.Assign ( HPS.UpdateNotifier  in_that )

inline

Share the underlying smart-pointer of the UpdateNotifier source.

Parameters

in_that

The UpdateNotifier source of the assignment.

Cancel()

HPS.UpdateNotifier HPS.UpdateNotifier.Cancel ( )

inline

Requests to cancel this Notifier's Update operation. The cancel operation returns without waiting for the Update to complete. To ensure that the Update is complete, you must call Wait().

Returns

A reference to this UpdateNotifier.

ObjectType()

override HPS.Type HPS.UpdateNotifier.ObjectType ( )

inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns

The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

Status()

HPS.Window.UpdateStatus HPS.UpdateNotifier.Status ( )

inline

Returns the HPS.Window.UpdateStatus for the Update represented by this UpdateNotifier.

Wait()

HPS.UpdateNotifier HPS.UpdateNotifier.Wait ( )

inline

Wait for this Notifier to complete its Update.

Returns

A reference to this UpdateNotifier.

---

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

• internals/hps_core/source/cs/HPS.UpdateNotifier.cs