All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
Pylon::WaitObjects Class Reference

A set of wait objects. More...

#include <pylon/WaitObjects.h>

Public Member Functions

 WaitObjects ()
 Creates an empty wait object set.
 
 ~WaitObjects ()
 destructor
 
 WaitObjects (const WaitObjects &)
 copy constructor
 
WaitObjectsoperator= (const WaitObjects &)
 assignment operator
 
unsigned Add (const WaitObject &o)
 Add an object to wait on and return the index of the added object. More...
 
void RemoveAll (void)
 Removes all added wait objects. More...
 
bool WaitForAll (unsigned timeout) const
 Wait for all objects to get signaled. More...
 
bool WaitForAny (unsigned timeout, unsigned *pIndex=NULL) const
 Wait for any one object to get signaled. More...
 
EWaitExResult WaitForAllEx (unsigned timeout, bool bAlertable) const
 Wait for all objects to get signaled. More...
 
EWaitExResult WaitForAnyEx (unsigned timeout, bool bAlertable, unsigned *pIndex=NULL) const
 Wait for any one object to get signaled. More...
 

Detailed Description

A set of wait objects.

Member Function Documentation

unsigned Pylon::WaitObjects::Add ( const WaitObject o)

Add an object to wait on and return the index of the added object.

Calling Add from another thread during wait operations will cause undefined behaviour.

void Pylon::WaitObjects::RemoveAll ( void  )

Removes all added wait objects.

Calling RemoveAll from another thread during wait operations will cause undefined behaviour.

bool Pylon::WaitObjects::WaitForAll ( unsigned  timeout) const

Wait for all objects to get signaled.

Parameters
timeoutmaximum wait period in milliseconds
Returns
true if all objects were signaled
EWaitExResult Pylon::WaitObjects::WaitForAllEx ( unsigned  timeout,
bool  bAlertable 
) const

Wait for all objects to get signaled.

Parameters
bAlertableIf true, the wait operation can be interrupted (Windows: APC; UNIX: signal)
timeoutmaximum wait period in milliseconds
bool Pylon::WaitObjects::WaitForAny ( unsigned  timeout,
unsigned *  pIndex = NULL 
) const

Wait for any one object to get signaled.

Parameters
timeoutmaximum wait period in milliseconds
*pIndex(optional) pointer to buffer taking the index of the signaled object
Returns
true if any object was signaled.
EWaitExResult Pylon::WaitObjects::WaitForAnyEx ( unsigned  timeout,
bool  bAlertable,
unsigned *  pIndex = NULL 
) const

Wait for any one object to get signaled.

Parameters
timeoutmaximum wait period in milliseconds
bAlertableIf true, the wait operation can be interrupted (Windows: APC; UNIX: signal)
*pIndex(optional) pointer to buffer taking the index of the signaled object

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

pylon 5.0.5
Copyright © 2006-2016 Basler AG (Thu Aug 11 2016 18:01:28)