Isomet Modular Synthesiser (iMS) API  v1.4.2
iMS API
List of all members
iMS::SequenceDownload Class Reference

This class is a worker for transmitting an ImageSequence to an iMS Controller and joining it to the back of the sequence queue. More...

#include <include\ImageOps.h>

Public Member Functions

Constructor & Destructor
 SequenceDownload (IMSSystem &ims, const ImageSequence &seq)
 Constructor for SequenceDownload Object. More...
 
 ~SequenceDownload ()
 Destructor.
 
Download Trigger
bool Download ()
 Adds a new sequence to the end of the iMS Controller Sequence Queue. More...
 

Detailed Description

This class is a worker for transmitting an ImageSequence to an iMS Controller and joining it to the back of the sequence queue.

Author
Dave Cowan
Date
2016-05-05
Since
1.2.4

Constructor & Destructor Documentation

iMS::SequenceDownload::SequenceDownload ( IMSSystem ims,
const ImageSequence seq 
)

Constructor for SequenceDownload Object.

The pre-requisites for an SequenceDownload object to be created are: (1) - an IMSSystem object, representing the iMS target to which the ImageSequence is to be downloaded. (2) - a complete ImageSequence object to download to the iMS target.

SequenceDownload stores references to both. This means that both must exist before the SequenceDownload object, and both must remain valid (not destroyed) until the SequenceDownload object itself is destroyed. Because they are stored as references, the IMSSystem and Image objects themselves may be modified after the construction of the SequenceDownload object.

Once constructed, the object can neither be copied or assigned to another instance.

Parameters
[in]imsA reference to the iMS System which is the target for downloading the ImageSequence
[in]seqA const reference to the ImageSequence which shall be downloaded to the target
Since
1.2.4

Member Function Documentation

bool iMS::SequenceDownload::Download ( )

Adds a new sequence to the end of the iMS Controller Sequence Queue.

Calling this function will program the list of ImageSequenceEntry's and the termination action/value from the ImageSequence object reference into a new sequence added to the end of the Sequence Queue.

Returns
True to indicate Sequence has been successfully added to the queue

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