Abstract interface for objects that can supply high-level testing events on a separte thread. More...
#include <pqThreadedEventSource.h>
Public Member Functions | |
| pqThreadedEventSource (QObject *p) | |
| ~pqThreadedEventSource () | |
| virtual int | getNextEvent (QString &object, QString &command, QString &arguments) |
| Called by the dispatcher on the GUI thread. | |
| bool | postNextEvent (const QString &object, const QString &command, const QString &argument) |
| The testing thread may post an event for the GUI to process. | |
| virtual void | stop () |
| tell this source to stop | |
| bool | waitForGUI () |
| Wait for the GUI thread to acknowledge an event. | |
| void | guiAcknowledge () |
| Give the testing thread an acknowledgement. | |
Static Public Member Functions | |
| static void | msleep (int msecs) |
Protected Member Functions | |
| virtual void | start () |
| void | done (int) |
| virtual void | run ()=0 |
Friends | |
| class | pqInternal |
Detailed Description
Abstract interface for objects that can supply high-level testing events on a separte thread.
This class is derived from, and run() is implemented.
Definition at line 45 of file pqThreadedEventSource.h.
Constructor & Destructor Documentation
| pqThreadedEventSource::pqThreadedEventSource | ( | QObject * | p | ) |
| pqThreadedEventSource::~pqThreadedEventSource | ( | ) |
Member Function Documentation
| virtual int pqThreadedEventSource::getNextEvent | ( | QString & | object, |
| QString & | command, | ||
| QString & | arguments | ||
| ) | [virtual] |
Called by the dispatcher on the GUI thread.
Retrieves the next available event. Returns true if an event was returned, false if there are no more events. In the case of a threaded event source, this function is called by the GUI thread and waits for the other thread to pos and event.
Implements pqEventSource.
| bool pqThreadedEventSource::postNextEvent | ( | const QString & | object, |
| const QString & | command, | ||
| const QString & | argument | ||
| ) |
The testing thread may post an event for the GUI to process.
This function blocks until there are no previously queued events to play. If the event plays successfully, true is returned.
| virtual void pqThreadedEventSource::stop | ( | ) | [virtual] |
tell this source to stop
Reimplemented from pqEventSource.
| bool pqThreadedEventSource::waitForGUI | ( | ) |
Wait for the GUI thread to acknowledge an event.
A previously locked mutex must be passed in. For use by the testing thread. If return value is false, an error occurred and the testing thread should terminate.
| void pqThreadedEventSource::guiAcknowledge | ( | ) |
Give the testing thread an acknowledgement.
For use by the GUI thread
| static void pqThreadedEventSource::msleep | ( | int | msecs | ) | [static] |
| virtual void pqThreadedEventSource::start | ( | ) | [protected, virtual] |
Reimplemented in pqPythonEventSource.
| void pqThreadedEventSource::done | ( | int | ) | [protected] |
| virtual void pqThreadedEventSource::run | ( | ) | [protected, pure virtual] |
Implemented in pqPythonEventSourceImage, and pqPythonEventSource.
Friends And Related Function Documentation
friend class pqInternal [friend] |
Definition at line 105 of file pqThreadedEventSource.h.
The documentation for this class was generated from the following file:
- /home/kitware/Dashboards/My Tests/ParaView/Qt/Testing/pqThreadedEventSource.h
