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:

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

enum pwiz::util::IterationListener::Status

Enumerator
Status_Ok
Status_Cancel

Definition at line 42 of file IterationListener.hpp.

{Status_Ok, Status_Cancel};

Constructor & Destructor Documentation

~IterationListener()

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

inlinevirtual

Definition at line 58 of file IterationListener.hpp.

{}

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.

References Status_Ok.

{return 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:

• /build/libpwiz-AP2CPb/libpwiz-3.0.10827/pwiz/utility/misc/IterationListener.hpp