epics::pvData::Event Class Reference

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

#include <misc/pv/event.h>

Public Types
typedef std::tr1::shared_ptr< Event >	shared_pointer
typedef std::tr1::shared_ptr< const Event >	const_shared_pointer
typedef std::tr1::weak_ptr< Event >	weak_pointer
typedef std::tr1::weak_ptr< const Event >	const_weak_pointer

Public Member Functions
	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.

Member Typedef Documentation

const_shared_pointer

std::tr1::shared_ptr<const Event> epics::pvData::Event::const_shared_pointer

Definition at line 33 of file event.h.

const_weak_pointer

std::tr1::weak_ptr<const Event> epics::pvData::Event::const_weak_pointer

Definition at line 33 of file event.h.

shared_pointer

std::tr1::shared_ptr<Event> epics::pvData::Event::shared_pointer

Definition at line 33 of file event.h.

weak_pointer

std::tr1::weak_ptr<Event> epics::pvData::Event::weak_pointer

Definition at line 33 of file event.h.

Constructor & Destructor Documentation

Event()

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

explicit

Constructor

~Event()

epics::pvData::Event::~Event

(

)

Destructor.

Member Function Documentation

signal()

void epics::pvData::Event::signal

(

)

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

tryWait()

bool epics::pvData::Event::tryWait

(

)

See if a signal has been called.

Returns

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

wait() [1/2]

bool epics::pvData::Event::wait

(

)

wait

Returns

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

wait() [2/2]

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).

---

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

• misc/pv/event.h