More...

Inheritance diagram for HPS.EventNotifier:
HPS.Object

Public Member Functions

virtual void Assign (HPS.EventNotifier in_that)
 Share the underlying smart-pointer of the EventNotifier source. 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. This does not necessarily give the true type of the underlying object. 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...
 
- Public Member Functions inherited from HPS.Object
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. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
virtual HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 

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 tied to an event object. It is a special type of control that is used for synchronizing with an event's completion.

Constructor & Destructor Documentation

HPS.EventNotifier.EventNotifier ( )
inline

The default constructor creates an EventNotifier object not tied to any event.

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

The copy constructor creates a new EventNotifier that is tied to the same event as the source EventNotifier.

Parameters
in_thatThe source EventNotifier to copy.

Member Function Documentation

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.
override HPS.Type HPS.EventNotifier.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS.Object.

HPS.Event.Status HPS.EventNotifier.Status ( )
inline

Query the status of the event this notifier is tied to.

Returns
    The current state of the event.
void HPS.EventNotifier.Wait ( )
inline

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


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