MrSID Decode SDK for Raster Reference Manual 9.5.4.4709

- Main Page
- Namespaces
- Classes
- Files
- Examples

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | List of all members
LTIInterruptDelegate Class Referenceabstract

interrupt delegate (callback) base class More...

`#include <lti_delegates.h>`

## Public Member Functions
virtual | ~LTIInterruptDelegate (void)
virtual LT_STATUS | getInterruptStatus (void)=0
| check for interrupt More...

## Detailed Description

This abstract class is used for implementing a mechanism to determine if a potentially long-running operation is to be interrupted, such as LTIImageStage::read() or LTIImageWriter::write(). During these sorts of operations, an object which has an interrupt delegate may periodically call the delegate's getInterruptStatus() method to determine if the operation should be aborted. If this function returns a value other than LT_STS_Success, then the object will abort the operation and return that status value.

Interrupt delegates are typically used in environments such as GUI encoders.

A "delegate" is simply an object-oriented version of a callback function.

Examples:
  InterruptDelegate.cpp.

Definition at line 39 of file lti_delegates.h.

## Constructor & Destructor Documentation

virtual LTIInterruptDelegate::~LTIInterruptDelegate | ( | void | ) |  |
| virtual

## Member Function Documentation

virtual LT_STATUS LTIInterruptDelegate::getInterruptStatus | ( | void | ) |  |
| pure virtual

This function should be implemented to indicate whether some user-defined event indicates that the operation should be terminated. If an interrupt is requested, a value other than LT_STS_Success should be returned.

Returns
  LT_STS_Success if no interrupt requested; any other (nonzero) value if an interrupt is requested

Examples:
  InterruptDelegate.cpp.

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

- lti_delegates.h

LizardTech