Isomet Modular Synthesiser (iMS) API  v1.4.2
iMS API
Public Types | List of all members
iMS::ImageDownloadEvents Class Reference

All the different types of events that can be triggered by the ImageDownload class. More...

#include <include\ImageOps.h>

Public Types

enum  Events {
  DOWNLOAD_FINISHED, DOWNLOAD_ERROR, VERIFY_SUCCESS, VERIFY_FAIL,
  DOWNLOAD_FAIL_MEMORY_FULL, DOWNLOAD_FAIL_TRANSFER_ABORT, IMAGE_DOWNLOAD_NEW_HANDLE, Count
}
 List of Events raised by the Image Downloader. More...
 

Detailed Description

All the different types of events that can be triggered by the ImageDownload class.

Some events contain integer parameter data which can be processed by the IEventHandler::EventAction derived method

Author
Dave Cowan
Date
2015-11-11
Since
1.0

Member Enumeration Documentation

List of Events raised by the Image Downloader.

Enumerator
DOWNLOAD_FINISHED 

Event raised when ImageDownload has confirmed that the iMS Controller received all of the Image data.

DOWNLOAD_ERROR 

Event raised each time the ImageDownload class registers an error in the download process.

VERIFY_SUCCESS 

Event raised on completion of a download verify, if the download was successfully verified.

VERIFY_FAIL 

Event raised on completion of a download verify, if the download failed. param contains the number of failures recorded.

DOWNLOAD_FAIL_MEMORY_FULL 

Event raise when unable to begin a fast transfer of image data to memory, e.g. Image memory is full.

DOWNLOAD_FAIL_TRANSFER_ABORT 

Event raise when unable to transfer any data through DMA mechanism.

IMAGE_DOWNLOAD_NEW_HANDLE 

Event raised when a new download has been accepted prior to memory transfer commencing, reporting the new image index handle.


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