Inheritance diagram for HPS.EventNotifier:
HPS.Object

Public Member Functions

virtual void Assign (HPS.EventNotifier in_that)
 
override void Dispose ()
 
 EventNotifier ()
 
 EventNotifier (HPS.EventNotifier in_that)
 
override HPS.Type ObjectType ()
 
HPS.Event.Status Status ()
 
HPS.EventNotifier 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 EventNotifier class is a smart pointer that is associated with an event object. It is a special type of control that is used for synchronizing with an event's completion.

Constructor & Destructor Documentation

◆ EventNotifier() [1/2]

HPS.EventNotifier.EventNotifier ( )
inline

The default constructor creates an EventNotifier object not associated with any event.

◆ EventNotifier() [2/2]

HPS.EventNotifier.EventNotifier ( HPS.EventNotifier  in_that)
inline

The copy constructor creates a new EventNotifier that is associated with the same event as the source EventNotifier.

Parameters
in_thatThe source EventNotifier to copy.

Member Function Documentation

◆ Assign()

virtual void HPS.EventNotifier.Assign ( HPS.EventNotifier  in_that)
inlinevirtual

Share the underlying smart-pointer of the EventNotifier source.

Parameters
in_thatThe EventNotifier source of the assignment.

◆ ObjectType()

override HPS.Type HPS.EventNotifier.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.Event.Status HPS.EventNotifier.Status ( )
inline

Query the status of the event for this notifier.

Returns
The current state of the event.

◆ Wait()

HPS.EventNotifier HPS.EventNotifier.Wait ( )
inline

Cause this thread to sleep until the event for this notifier has been handled.

Returns
A reference to this EventNotifier.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.EventNotifier.cs