ProteoWizard
Public Member Functions | Private Attributes | List of all members
CancelListener Class Reference
Inheritance diagram for CancelListener:
pwiz::util::IterationListener

Public Member Functions

 CancelListener (size_t cancelIndex)
 
virtual Status update (const UpdateMessage &updateMessage)
 
- Public Member Functions inherited from pwiz::util::IterationListener
virtual ~IterationListener ()
 

Private Attributes

size_t cancelIndex_
 

Additional Inherited Members

- Public Types inherited from pwiz::util::IterationListener
enum  Status { Status_Ok, Status_Cancel }
 
- Static Public Attributes inherited from pwiz::util::IterationListener
static std::string no_message
 

Detailed Description

Definition at line 61 of file IterationListenerTest.cpp.

Constructor & Destructor Documentation

◆ CancelListener()

CancelListener::CancelListener ( size_t  cancelIndex)
inline

Definition at line 65 of file IterationListenerTest.cpp.

66  : cancelIndex_(cancelIndex)
67  {}

Member Function Documentation

◆ update()

virtual Status CancelListener::update ( const UpdateMessage updateMessage)
inlinevirtual

Reimplemented from pwiz::util::IterationListener.

Definition at line 69 of file IterationListenerTest.cpp.

70  {
71  if (os_) *os_ << "[cancel] " << updateMessage.iterationIndex << "/"
72  << updateMessage.iterationCount << endl;
73 
74  return updateMessage.iterationIndex==cancelIndex_ ? Status_Cancel : Status_Ok;
75  }

References pwiz::util::IterationListener::UpdateMessage::iterationCount, pwiz::util::IterationListener::UpdateMessage::iterationIndex, os_, and Status_Ok.

Member Data Documentation

◆ cancelIndex_

size_t CancelListener::cancelIndex_
private

Definition at line 78 of file IterationListenerTest.cpp.


The documentation for this class was generated from the following file:
os_
ostream * os_
Definition: IterationListenerTest.cpp:34
pwiz::util::IterationListener::Status_Cancel
@ Status_Cancel
Definition: IterationListener.hpp:42
pwiz::util::IterationListener::Status_Ok
@ Status_Ok
Definition: IterationListener.hpp:42
CancelListener::cancelIndex_
size_t cancelIndex_
Definition: IterationListenerTest.cpp:78