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

Completely specifies the desired compensation at a spot frequency. More...

#include <include/Compensation.h>

Constructor & Destructor

 CompensationPointSpecification (CompensationPoint pt=CompensationPoint(), MHz f=50.0)
 Constructor for CompensationPointSpecification Object. More...
 
 ~CompensationPointSpecification ()
 Destructor for CompensationPointSpecification Object.
 
 CompensationPointSpecification (const CompensationPointSpecification &)
 Copy Constructor.
 
CompensationPointSpecificationoperator= (const CompensationPointSpecification &)
 Assignment Constructor.
 
bool operator== (CompensationPointSpecification const &rhs) const
 Equality Operator. More...
 
void Freq (const MHz &f)
 Sets the frequency (in MHz) at which the CompensationPointSpecification is valid.
 
const MHzFreq ()
 Gets the CompensationPointSpecification frequency.
 
void Spec (const CompensationPoint &pt)
 Sets the specification data for this CompensationPointSpecification frequency point.
 
const CompensationPointSpec ()
 Gets the specification data for this CompensationPointSpecification frequency point.
 

Detailed Description

Completely specifies the desired compensation at a spot frequency.

A CompensationPointSpecification object is the basic unit of a Compensation Function. It is required to know the Frequency at which the specification is made and this frequency must fall within the frequency range of the Synthesiser on which the resulting CompensationTable will be programmed else the specification will be disregarded in the CompensationFunction calculation.

The calling software can program any of the Compensation parameters (amplitude, phase, synchronous analog or digital) and the programmed value will be used to generate CompensationTable data by the CompensationFunction calculation.

Author
Dave Cowan
Date
2016-11-03
Since
1.3

Constructor & Destructor Documentation

iMS::CompensationPointSpecification::CompensationPointSpecification ( CompensationPoint  pt = CompensationPoint(),
MHz  f = 50.0 
)

Constructor for CompensationPointSpecification Object.

Since
1.3

Member Function Documentation

bool iMS::CompensationPointSpecification::operator== ( CompensationPointSpecification const &  rhs) const

Equality Operator.

Since
1.3

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