Isomet Modular Synthesiser (iMS) API  v1.4.2
iMS API
Public Member Functions | Public Attributes | List of all members
iMS::FAP Struct Reference

FAP (Frequency/Amplitude/Phase) triad stores the instantaneous definition of a single RF output. More...

#include <include/IMSTypeDefs.h>

Collaboration diagram for iMS::FAP:
Collaboration graph
[legend]

Public Member Functions

 FAP ()
 Default construct a FAP object with zero data.
 
 FAP (double f, double a, double p)
 Construct a FAP object from raw double precision input data.
 
 FAP (MHz f, Percent a, Degrees p)
 Construct a FAP object from pre-existing MHz, Percent and Degrees objects.
 
Equality Operators
bool operator== (const FAP &other) const
 Equality operators compare FAPs against each other. More...
 
bool operator!= (const FAP &other) const
 

Public Attributes

MHz freq
 The RF Channel Output Frequency.
 
Percent ampl
 The RF Channel Output Amplitude.
 
Degrees phase
 The RF Channel Output Phase.
 

Detailed Description

FAP (Frequency/Amplitude/Phase) triad stores the instantaneous definition of a single RF output.

The FAP struct, also known as a triad, stores one frequency (in MHz), one amplitude (Percent) and one phase (Degrees) value which uniquely specifies the instantaneous output of any one RF channel output.

4 FAP's make up a single ImagePoint, one per RF channel, and sequences of ImagePoints then make up an Image.

Author
Dave Cowan
Date
2015-11-03
Since
1.0

Member Function Documentation

bool iMS::FAP::operator== ( const FAP other) const

Equality operators compare FAPs against each other.

Since
1.1.0

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