Dataflow Runtime API  3.0.3.0
Public Member Functions | List of all members
imt::base::os::winec7::OSEvent Class Reference

Encapsulates an event. More...

#include <Imt.Base.OS.WinEC7/OSEvent.h>

Public Member Functions

 OSEvent (const std::wstring &name, const bool isNamedEvent)
 Constructor. More...
 
 OSEvent (const std::wstring &name, void *const pHandle)
 Constructor. More...
 
virtual ~OSEvent (void)
 Destructor. More...
 
void * getEventHandle (void)
 Gets the handle of this event. More...
 
void setEvent (void)
 Signals this event. More...
 
const std::wstring & getEventName (void) const
 Returns the name of this event. More...
 

Detailed Description

Encapsulates an event.

Constructor & Destructor Documentation

◆ OSEvent() [1/2]

imt::base::os::winec7::OSEvent::OSEvent ( const std::wstring &  name,
const bool  isNamedEvent 
)
explicit

Constructor.

Parameters
nameName of the event.
isNamedEventCreate a named event or not.

◆ OSEvent() [2/2]

imt::base::os::winec7::OSEvent::OSEvent ( const std::wstring &  name,
void *const  pHandle 
)
explicit

Constructor.

Creates an OSEvent with the given event handle.

Parameters
nameName of the event.
pHandleExisting event handle for the event.

◆ ~OSEvent()

virtual imt::base::os::winec7::OSEvent::~OSEvent ( void  )
virtual

Destructor.

Member Function Documentation

◆ getEventHandle()

void* imt::base::os::winec7::OSEvent::getEventHandle ( void  )

Gets the handle of this event.

◆ getEventName()

const std::wstring& imt::base::os::winec7::OSEvent::getEventName ( void  ) const

Returns the name of this event.

Returns
The name of this event.

◆ setEvent()

void imt::base::os::winec7::OSEvent::setEvent ( void  )

Signals this event.


The documentation for this class was generated from the following file: