ProteoWizard
Classes | Public Types | Public Member Functions | Static Public Attributes | List of all members
pwiz::util::IterationListener Class Reference

interface to be implemented by clients who want progress callbacks More...

#include <IterationListener.hpp>

Inheritance diagram for pwiz::util::IterationListener:
BadListener CancelListener TestIterationListener TestIterationListener_WithCancel TestListener

Classes

struct  UpdateMessage
 

Public Types

enum  Status { Status_Ok, Status_Cancel }
 

Public Member Functions

virtual Status update (const UpdateMessage &updateMessage)
 
virtual ~IterationListener ()
 

Static Public Attributes

static std::string no_message
 

Detailed Description

interface to be implemented by clients who want progress callbacks

Definition at line 38 of file IterationListener.hpp.

Member Enumeration Documentation

◆ Status

Enumerator
Status_Ok 
Status_Cancel 

Definition at line 42 of file IterationListener.hpp.

Constructor & Destructor Documentation

◆ ~IterationListener()

virtual pwiz::util::IterationListener::~IterationListener ( )
inlinevirtual

Definition at line 58 of file IterationListener.hpp.

58 {}

Member Function Documentation

◆ update()

virtual Status pwiz::util::IterationListener::update ( const UpdateMessage updateMessage)
inlinevirtual

Reimplemented in TestIterationListener_WithCancel, TestIterationListener, BadListener, CancelListener, and TestListener.

Definition at line 56 of file IterationListener.hpp.

56 {return Status_Ok;}

References Status_Ok.

Member Data Documentation

◆ no_message

std::string pwiz::util::IterationListener::no_message
static

Definition at line 43 of file IterationListener.hpp.


The documentation for this class was generated from the following file:
pwiz::util::IterationListener::Status_Cancel
@ Status_Cancel
Definition: IterationListener.hpp:42
pwiz::util::IterationListener::Status_Ok
@ Status_Ok
Definition: IterationListener.hpp:42