API Search || Global Search

#include <hps.h>

Inheritance diagram for HPS::EventNotifier:
HPS::Object

Public Member Functions

virtual void Assign (EventNotifier const &in_that)
 
 EventNotifier ()
 
 EventNotifier (EventNotifier const &in_that)
 
 EventNotifier (EventNotifier &&in_that)
 
HPS::Type ObjectType () const
 
EventNotifieroperator= (EventNotifier &&in_that)
 
EventNotifieroperator= (EventNotifier const &in_that)
 
Event::Status Status () const
 
EventNotifier const & Wait () const
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::EventNotifier
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

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

HPS::EventNotifier::EventNotifier ( )

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

HPS::EventNotifier::EventNotifier ( EventNotifier const &  in_that)

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.
HPS::EventNotifier::EventNotifier ( EventNotifier &&  in_that)

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_thatAn rvalue reference to an EventNotifier to take the impl from.

Member Function Documentation

virtual void HPS::EventNotifier::Assign ( EventNotifier const &  in_that)
virtual

Share the underlying smart-pointer of the EventNotifier source.

Parameters
in_thatThe EventNotifier source of the assignment.
EventNotifier& HPS::EventNotifier::operator= ( EventNotifier &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this Control thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to an Control to take the impl from.
Returns
A reference to this Control.
EventNotifier& HPS::EventNotifier::operator= ( EventNotifier const &  in_that)

Share the underlying smart-pointer of the EventNotifier source.

Parameters
in_thatThe EventNotifier source of the assignment.
Returns
A reference to this EventNotifier.
Event::Status HPS::EventNotifier::Status ( ) const

Query the status of the event for this notifier.

Returns
The current state of the event.
EventNotifier const& HPS::EventNotifier::Wait ( ) const

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: