pqThreadedEventSource.h 2.81 KB
Newer Older
Clinton Stimpson's avatar
 
Clinton Stimpson committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
/*=========================================================================

   Program: ParaView
   Module:    pqThreadedEventSource.h

   Copyright (c) 2005,2006 Sandia Corporation, Kitware Inc.
   All rights reserved.

   ParaView is a free software; you can redistribute it and/or modify it
   under the terms of the ParaView license version 1.1. 

   See License_v1.1.txt for the full ParaView license.
   A copy of this license can be obtained by contacting
   Kitware Inc.
   28 Corporate Drive
   Clifton Park, NY 12065
   USA

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

=========================================================================*/

#ifndef _pqThreadedEventSource_h
#define _pqThreadedEventSource_h

#include "QtTestingExport.h"
#include "pqEventSource.h"

class QString;

/// Abstract interface for objects that can supply high-level testing events
/// on a separte thread.  This class is derived from, and run() is
/// implemented.
class QTTESTING_EXPORT pqThreadedEventSource : public pqEventSource
{
  Q_OBJECT
public:
Clinton Stimpson's avatar
 
Clinton Stimpson committed
48
  pqThreadedEventSource(QObject* p);
Clinton Stimpson's avatar
 
Clinton Stimpson committed
49 50 51 52 53 54 55
  ~pqThreadedEventSource();

  /** 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. */
Clinton Stimpson's avatar
 
Clinton Stimpson committed
56
  virtual int getNextEvent(
Clinton Stimpson's avatar
 
Clinton Stimpson committed
57 58 59 60 61 62 63 64 65 66 67 68
    QString& object,
    QString& command,
    QString& arguments);
  
  /** The testing thread may post an event for the GUI to process.
      This function blocks until there are no previously queued events to play.  */
  void postNextEvent(const QString& object,
                     const QString& command,
                     const QString& argument);
  
protected:

Clinton Stimpson's avatar
 
Clinton Stimpson committed
69 70
  bool event(QEvent* e);

Clinton Stimpson's avatar
 
Clinton Stimpson committed
71 72 73 74
  // start the thread
  void start();

  // called by the testing thread to signify it is done
Clinton Stimpson's avatar
 
Clinton Stimpson committed
75 76
  // pass in zero for success, non-zero for failure
  void done(int);
Clinton Stimpson's avatar
 
Clinton Stimpson committed
77 78 79 80 81 82 83 84 85 86 87 88

  // run the thread, return 
  virtual void run() = 0;

private:
  class pqInternal;
  pqInternal* Internal;

};

#endif // !_pqThreadedEventSource_h