Isomet Modular Synthesiser (iMS) API
v1.4.2
iMS API
|
Type Definition for all operations that require a percentage specification. More...
#include <include/IMSTypeDefs.h>
Public Member Functions | |
Percent () | |
Default Constructor assigns 0.0%. More... | |
Percent (double arg) | |
Construct a Percent object from a double argument and check its value is within the range 0.0 <= arg <= 100.0. If not, the object is still constructed, but the value is clipped to the upper or lower bound. More... | |
Percent & | operator= (double arg) |
Assignment of a double argument in percent to an existing Percent object. More... | |
operator double () const | |
Return a double representing the Percent object's value. More... | |
Static Public Member Functions | |
static unsigned int | RenderAsImagePoint (const IMSSystem &, const Percent) |
Used internally by the library to convert a Percent object into a hardware-dependent integer representation used by the Image for RF Output amplitude. More... | |
static unsigned int | RenderAsCompensationPoint (const IMSSystem &, const Percent) |
Used internally by the library to convert a Percent object into a hardware-dependent integer representation used by the Compensation Table for Compensation amplitude. More... | |
static unsigned int | RenderAsCalibrationTone (const IMSSystem &, const Percent) |
Used internally by the library to convert a Percent object into a hardware-dependent integer representation used by the Calibration Tone for Single Tone amplitude. More... | |
Type Definition for all operations that require a percentage specification.
Internally, the Percent value is stored as a double precision variable and is bounds-limited to 0.0 <= Percent <= 100.0.
|
inline |
Default Constructor assigns 0.0%.
|
inline |
Construct a Percent object from a double argument and check its value is within the range 0.0 <= arg <= 100.0. If not, the object is still constructed, but the value is clipped to the upper or lower bound.
[in] | arg | The percentage value |
|
inline |
Return a double representing the Percent object's value.
|
inline |
Assignment of a double argument in percent to an existing Percent object.
The double argument of the assigner must be within the range 0.0 <= arg <= 100.0 else it will be limited to those bounds.
prints:
|
static |
Used internally by the library to convert a Percent object into a hardware-dependent integer representation used by the Calibration Tone for Single Tone amplitude.
Not intended for use in application code
|
static |
Used internally by the library to convert a Percent object into a hardware-dependent integer representation used by the Compensation Table for Compensation amplitude.
Not intended for use in application code