epics::pvData::Event Class Reference

C++ wrapper for epicsEvent from EPICS base. More...

#include "event.h"

Public Member Functions
	POINTER_DEFINITIONS (Event)
	Event (bool=false)
	~Event ()
void	signal ()
bool	wait ()
bool	wait (double timeOut)
bool	tryWait ()

Detailed Description

C++ wrapper for epicsEvent from EPICS base.

Definition at line 31 of file event.h.

Constructor & Destructor Documentation

epics::pvData::Event::Event ( bool  full = false )

explicit

Constructor

Definition at line 39 of file event.cpp.

: id(epicsEventCreate(full?epicsEventFull : epicsEventEmpty))
{
}

epics::pvData::Event::~Event

(

)

Destructor.

Definition at line 33 of file event.cpp.

              {
    epicsEventDestroy(id);
    id = 0;
}

Member Function Documentation

epics::pvData::Event::POINTER_DEFINITIONS

(

Event

)

void epics::pvData::Event::signal

(

)

Signal the event i.e. ensures that the next or current call to wait completes.

Definition at line 44 of file event.cpp.

{
    if(id==0) throw std::logic_error(string("event was deleted"));
    epicsEventSignal(id);
}

bool epics::pvData::Event::tryWait

(

)

See if a signal has been called.

Returns

(false, true) if (timeout or error, event signaled).

Definition at line 64 of file event.cpp.

{
    if(id==0) throw std::logic_error(string("event was deleted"));
    epicsEventWaitStatus status = epicsEventTryWait(id);
    return status==epicsEventWaitOK ? true : false;
}

bool epics::pvData::Event::wait

(

)

wait

Returns

(false,true) if (some error, event signaled). The next wait or tryWait will clear signal.

Definition at line 50 of file event.cpp.

{
    if(id==0) throw std::logic_error(string("event was deleted"));
    epicsEventWaitStatus status = epicsEventWait(id);
    return status==epicsEventWaitOK ? true : false;
}

bool epics::pvData::Event::wait

(

double

timeOut

)

wait for up to timeOut seconds.

Parameters

timeOut

max number of seconds to wait

Returns

(false, true) if (timeout or error, event signaled).

Definition at line 57 of file event.cpp.

{
    if(id==0) throw std::logic_error(string("event was deleted"));
    epicsEventWaitStatus status = epicsEventWaitWithTimeout(id,timeOut);
    return status==epicsEventWaitOK ? true : false;
}

---

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

• modules/pvData/src/misc/pv/event.h
• modules/pvData/src/misc/event.cpp