ParaView
Public Types | Public Member Functions
pqEventSource Class Reference

Abstract interface for objects that can supply high-level testing events. More...

#include <pqEventSource.h>

Inheritance diagram for pqEventSource:
Inheritance graph
[legend]

List of all members.

Public Types

enum  { SUCCESS, FAILURE, DONE }

Public Member Functions

 pqEventSource (QObject *p)
virtual ~pqEventSource ()
virtual int getNextEvent (QString &object, QString &command, QString &arguments)=0
 Retrieves the next available event.
virtual void setContent (const QString &filename)=0
 Set the filename for contents.
virtual void stop ()
 tell the source to stop feeding in events

Detailed Description

Abstract interface for objects that can supply high-level testing events.

Definition at line 41 of file pqEventSource.h.


Member Enumeration Documentation

anonymous enum
Enumerator:
SUCCESS 
FAILURE 
DONE 

Definition at line 48 of file pqEventSource.h.


Constructor & Destructor Documentation

pqEventSource::pqEventSource ( QObject *  p) [inline]

Definition at line 45 of file pqEventSource.h.

virtual pqEventSource::~pqEventSource ( ) [inline, virtual]

Definition at line 46 of file pqEventSource.h.


Member Function Documentation

virtual int pqEventSource::getNextEvent ( QString &  object,
QString &  command,
QString &  arguments 
) [pure virtual]

Retrieves the next available event.

Returns SUCCESS if an event was returned and can be processed, FAILURE if there was a problem, DONE, if there are no more events.

Implemented in pqThreadedEventSource, and pqXMLEventSource.

virtual void pqEventSource::setContent ( const QString &  filename) [pure virtual]

Set the filename for contents.

Returns true for valid file, false for invalid file

Implemented in pqXMLEventSource, and pqPythonEventSource.

virtual void pqEventSource::stop ( ) [inline, virtual]

tell the source to stop feeding in events

Reimplemented in pqThreadedEventSource.

Definition at line 64 of file pqEventSource.h.


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