Pylon::WaitObjectEx#

A wait object that the user may signal.

#include <pylon/WaitObject.h>

Inherits from Pylon::WaitObject

Public Functions#

Additional inherited members#

Public Functions inherited from Pylon::WaitObject

Public Functions Documentation#

function Create#

static WaitObjectEx Create(
    bool initiallySignalled =false
)

Creates an event object (manual reset event)

function Sleep#

static void Sleep(
    unsigned long ms
)

Suspend calling thread for specified time.

Parameters:

• ms wait time in ms

function WaitObjectEx#

WaitObjectEx()

Constructs an "empty" wait object, i.e., the wait object is not attached to a platform dependent wait object (IsValid() == false)

Use the static WaitObjectEx::Create() method to create instances of the WaitObjectEx class instead.

function ~WaitObjectEx#

inline virtual ~WaitObjectEx()

Destroys the waitobject.

function Signal#

void Signal()

Set the object to signaled state.

function Reset#

void Reset()

Reset the object to unsignaled state.

function WaitObjectEx#

explicit WaitObjectEx(
    WaitObject_t h,
    bool duplicate =true
)

Constructor using an existing windows handle (duplicate=false -> take ownership like std:auto_ptr)

function IsValid#

bool IsValid() const

Checks if the wait object is valid.

Return: true if the object contains a valid handle/file descriptor

Don't call the Wait methods() for an invalid wait object. Wait objects returned by the pylon libraries are valid.

function Wait#

bool Wait(
    unsigned int timeout
) const

Wait for the object to be signaled.

Parameters:

• timeout timeout in ms

Return: false when the timeout has been expired, true when the waiting was successful before the timeout has been expired.

function WaitEx#

EWaitExResult WaitEx(
    unsigned int timeout,
    bool bAlertable
) const

Wait for the object to be signaled (interruptible)

Parameters:

• timeout timeout in ms
• bAlertable When the bAlertable parameter is set to true, the function waits until either the timeout elapses, the object enters the signaled state, or the wait operation has been interrupted. For Windows, the wait operation is interrupted by queued APCs or I/O completion routines. For Linux, the wait operation can be interrupted by signals.

Return: The returned Pylon::EWaitExResult value indicates the result of the wait operation.

function operator WaitObject_t#

operator WaitObject_t() const

conversion operator

Return: the native Win32 handle wrapped by the WaitObject. (Not supported by pylon4Linux)