Isomet Modular Synthesiser (iMS) API
v1.4.2
iMS API
|
Stores 4 FAP Triads containing frequency, amplitude and phase data for 4 RF channels. More...
#include <include/Image.h>
Public Member Functions | |
ImagePoint () | |
Default Constructor. | |
ImagePoint (FAP fap) | |
Constructor with Uniform Channel Data. More... | |
ImagePoint (FAP ch1, FAP ch2, FAP ch3, FAP ch4) | |
Constructor with Independent Channel Data. More... | |
ImagePoint (FAP fap, float synca, unsigned int syncd) | |
Constructor with Uniform Channel Data and Synchronous Data. More... | |
ImagePoint (FAP ch1, FAP ch2, FAP ch3, FAP ch4, float synca_1, float synca_2, unsigned int syncd) | |
Constructor with Independent Channel Data and Synchronous Data. More... | |
bool | operator== (ImagePoint const &rhs) const |
Equality Operator checks ImagePoint object for equivalence. More... | |
Get/Set FAP data for the image point | |
const FAP & | GetFAP (const RFChannel) const |
Retrieves Frequency, Amplitude (Percent) and Phase (Degrees) data for one RF channel. More... | |
void | SetFAP (const RFChannel, const FAP &) |
Assigns Frequency, Amplitude (Percent) and Phase (Degrees) data for one RF channel. More... | |
FAP & | SetFAP (const RFChannel) |
Assigns Frequency, Amplitude (Percent) and Phase (Degrees) data for one RF channel. More... | |
void | SetAll (const FAP &) |
Assigns Frequency, Amplitude (Percent) and Phase (Degrees) data for all RF channels. More... | |
Get/Set Synchronous data for the image point | |
const float & | GetSyncA (int index) const |
Retrieve Analogue Synchronous Data. More... | |
void | SetSyncA (int index, const float &value) |
Assign Analogue Synchronous Data. More... | |
const unsigned int & | GetSyncD () const |
Retrieve Digital Synchronous Data. More... | |
void | SetSyncD (const unsigned int &value) |
Assign Digital Synchronous Data. More... | |
Stores 4 FAP Triads containing frequency, amplitude and phase data for 4 RF channels.
An ImagePoint uniquely defines the required output drive setting for each of the 4 RF Channels output by the iMS Synthesiser. Each channel (from 1 to 4) is given its own FAP member variable, which is a combination of Frequency, Amplitude (Percent) and Phase (Degrees) data.
At any instantaneous moment, the status of the 4 iMS RF driver outputs is representable by a single ImagePoint
iMS::ImagePoint::ImagePoint | ( | FAP | fap | ) |
Constructor with Uniform Channel Data.
Construct ImagePoint with identical FAP for each channel
Constructor with Independent Channel Data.
Construct ImagePoint with full specification of FAP for each channel
iMS::ImagePoint::ImagePoint | ( | FAP | fap, |
float | synca, | ||
unsigned int | syncd | ||
) |
Constructor with Uniform Channel Data and Synchronous Data.
Construct ImagePoint with identical FAP for each channel
iMS::ImagePoint::ImagePoint | ( | FAP | ch1, |
FAP | ch2, | ||
FAP | ch3, | ||
FAP | ch4, | ||
float | synca_1, | ||
float | synca_2, | ||
unsigned int | syncd | ||
) |
Constructor with Independent Channel Data and Synchronous Data.
Construct ImagePoint with full specification of FAP for each channel
const float& iMS::ImagePoint::GetSyncA | ( | int | index | ) | const |
Retrieve Analogue Synchronous Data.
[in] | index | 0 or 1 references 2 independent synchronous data variables |
const unsigned int& iMS::ImagePoint::GetSyncD | ( | ) | const |
Retrieve Digital Synchronous Data.
bool iMS::ImagePoint::operator== | ( | ImagePoint const & | rhs | ) | const |
Equality Operator checks ImagePoint object for equivalence.
[in] | rhs | An ImagePoint object to perform the comparison with |
void iMS::ImagePoint::SetAll | ( | const FAP & | ) |
void iMS::ImagePoint::SetSyncA | ( | int | index, |
const float & | value | ||
) |
Assign Analogue Synchronous Data.
[in] | index | 0 or 1 references 2 independent synchronous data variables |
[in] | value | The floating point value to assign, will be clamped within the range 0 <= value <= 1 |
void iMS::ImagePoint::SetSyncD | ( | const unsigned int & | value | ) |
Assign Digital Synchronous Data.
[in] | value | The unsigned integer value to assign |