#include <hps.h>
|
static const HPS::Type | staticType = HPS::Type::EventNotifier |
|
static const HPS::Type | staticType = HPS::Type::None |
|
|
template<typename T > |
static intptr_t | ClassID () |
|
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.
◆ EventNotifier() [1/3]
HPS::EventNotifier::EventNotifier |
( |
| ) |
|
The default constructor creates an EventNotifier object not associated with any event.
◆ EventNotifier() [2/3]
HPS::EventNotifier::EventNotifier |
( |
EventNotifier const & |
in_that | ) |
|
◆ EventNotifier() [3/3]
The move constructor creates an EventNotifier by transferring the underlying impl of the rvalue reference to this Key thereby avoiding a copy and allocation.
- Parameters
-
in_that | An rvalue reference to an EventNotifier to take the impl from. |
◆ Assign()
virtual void HPS::EventNotifier::Assign |
( |
EventNotifier const & |
in_that | ) |
|
|
virtual |
Share the underlying smart-pointer of the EventNotifier source.
- Parameters
-
◆ ObjectType()
HPS::Type HPS::EventNotifier::ObjectType |
( |
| ) |
const |
|
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.
◆ operator=() [1/2]
The move assignment operator transfers the underlying impl of the rvalue reference to this Control thereby avoiding a copy.
- Parameters
-
in_that | An rvalue reference to an Control to take the impl from. |
- Returns
- A reference to this Control.
◆ operator=() [2/2]
◆ Status()
Query the status of the event for this notifier.
- Returns
- The current state of the event.
◆ Wait()
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: