REFERENCE MANUAL
The EventNotifier class is a smart pointer that is tied to an event object. More...
Public Member Functions | |
virtual void | Assign (HPS.EventNotifier in_that) |
Share the underlying smart-pointer. More... | |
override void | Dispose () |
EventNotifier () | |
The default constructor creates an EventNotifier object not tied to any event. More... | |
EventNotifier (HPS.EventNotifier in_that) | |
The copy constructor creates a new EventNotifier that is tied to the same event as the source EventNotifier. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
HPS.Event.Status | Status () |
Query the status of the event this notifier is tied to. More... | |
void | Wait () |
Cause this thread to sleep until the event this notifier is tied to has been handled. More... | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The EventNotifier class is a smart pointer that is tied to an event object.
It is a special type of control that is used for synchronizing with an event's completion.
HPS.EventNotifier.EventNotifier | ( | ) |
The default constructor creates an EventNotifier object not tied to any event.
HPS.EventNotifier.EventNotifier | ( | HPS.EventNotifier | in_that | ) |
The copy constructor creates a new EventNotifier that is tied to the same event as the source EventNotifier.
in_that | The source <ref refid="class_h_p_s_1_1_event_notifier" kindref="compound">EventNotifier</ref> to copy. |
|
virtual |
Share the underlying smart-pointer.
in_that | The source of the assignment. |
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
HPS.Event.Status HPS.EventNotifier.Status | ( | ) |
Query the status of the event this notifier is tied to.
void HPS.EventNotifier.Wait | ( | ) |
Cause this thread to sleep until the event this notifier is tied to has been handled.