Type that represents the integer values 1, 2, 3 and 4, one each for the RF Channels of an iMS Synthesiser.
More...
#include <include/IMSTypeDefs.h>
|
| RFChannel () |
| Default construct an RF Channel object initialised to the first RF Channel. More...
|
|
| RFChannel (int arg) |
| Construct an RF Channel object and check that it is being created with an integer value within the range 1 <= arg <= 4. If not, the object is still constructed, but the RF Channel value is set to 1 and an invalid_argument exception is thrown. More...
|
|
RFChannel & | operator= (int arg) |
| Assignment of an integer argument to an existing RF Channel object. More...
|
|
| operator int () const |
| Return an integer representing the RF Channel that the object references. More...
|
|
|
RFChannel & | operator++ () |
| Prefix and Postfix operators for (dec)incrementing through channels. More...
|
|
RFChannel | operator++ (int) |
|
RFChannel & | operator-- () |
|
RFChannel | operator-- (int) |
|
Type that represents the integer values 1, 2, 3 and 4, one each for the RF Channels of an iMS Synthesiser.
The type is used to ensure that incorrect channel specifications cannot be passed to functions requiring an argument referencing an RF output channel. Attempting to use an integer outside the range 1 <= arg <= 4 will result in RFChannel = 1 and an invalid_argument exception being thrown.
- Exceptions
-
std::invalid_argument("Invalid | RF Channel Number") Attempted to use an integer specification not tied to an RF Output Channel |
- Author
- Dave Cowan
- Date
- 2015-11-03
- Since
- 1.0
iMS::RFChannel::RFChannel |
( |
| ) |
|
|
inline |
Default construct an RF Channel object initialised to the first RF Channel.
- Since
- 1.1
iMS::RFChannel::RFChannel |
( |
int |
arg | ) |
|
|
inline |
Construct an RF Channel object and check that it is being created with an integer value within the range 1 <= arg <= 4. If not, the object is still constructed, but the RF Channel value is set to 1 and an invalid_argument exception is thrown.
- Parameters
-
[in] | arg | The channel specification |
- Exceptions
-
std::invalid_argument("Invalid | RF Channel Number") Attempted to use an integer specification not tied to an RF Output Channel |
- Since
- 1.0
iMS::RFChannel::operator int |
( |
| ) |
const |
|
inline |
Return an integer representing the RF Channel that the object references.
- Since
- 1.0
Prefix and Postfix operators for (dec)incrementing through channels.
- Since
- 1.1
RFChannel& iMS::RFChannel::operator= |
( |
int |
arg | ) |
|
|
inline |
Assignment of an integer argument to an existing RF Channel object.
Checks that it is being created with an integer value within the range 1 <= arg <= 4. If not, the object is still constructed, but the RF Channel value is set to 1 and an invalid_argument exception is thrown
- Parameters
-
[in] | arg | The channel specification |
- Exceptions
-
std::invalid_argument("Invalid | RF Channel Number") Attempted to use an integer specification not tied to an RF Output Channel |
- Since
- 1.0
The documentation for this class was generated from the following file: