Isomet Modular Synthesiser (iMS) API
v1.4.2
iMS API
|
Stores Capabilities, Description, Model & Version Number of an iMS Synthesiser. More...
#include <include/IMSSystem.h>
Classes | |
struct | Capabilities |
Returns information about the capabilities of the Synthesiser hardware. More... | |
Public Member Functions | |
const Capabilities | GetCap () const |
Returns the Capabilities structure for the Synthesiser. More... | |
const std::string & | Description () const |
Returns a descriptive string for the Synthesiser. More... | |
const std::string & | Model () const |
Returns the short model number for the Synthesiser. More... | |
const FWVersion & | GetVersion () const |
Returns the Firmware version for the Synthesiser. More... | |
const bool | IsValid () const |
Returns true if the system scan successfully identified the Synthesiser and initialised this Class. More... | |
const FileSystemTable & | FST () const |
Returns the FileSystemTable for the Synthesiser. More... | |
Public Attributes | |
IMSOption * | AddOn |
If there are any Options attached to the Synthesiser, these are accessed here, else a null pointer is returned. | |
Stores Capabilities, Description, Model & Version Number of an iMS Synthesiser.
An IMSSynthesiser class is a member of the IMSSystem class and contains valid information about an iMS Synthesiser if the ConnectionList::scan() function was able to successfully identify it.
The fields that can be read back to describe the Synthesiser can be used in Application code to select between Synthesisers, display information about them or determine capabilities. The information is also used by internal library functions to correctly format data and messages that are sent to the hardware.
const std::string& iMS::IMSSynthesiser::Description | ( | ) | const |
Returns a descriptive string for the Synthesiser.
const FileSystemTable& iMS::IMSSynthesiser::FST | ( | ) | const |
Returns the FileSystemTable for the Synthesiser.
const Capabilities iMS::IMSSynthesiser::GetCap | ( | ) | const |
Returns the Capabilities structure for the Synthesiser.
const FWVersion& iMS::IMSSynthesiser::GetVersion | ( | ) | const |
Returns the Firmware version for the Synthesiser.
const bool iMS::IMSSynthesiser::IsValid | ( | ) | const |
Returns true if the system scan successfully identified the Synthesiser and initialised this Class.
const std::string& iMS::IMSSynthesiser::Model | ( | ) | const |
Returns the short model number for the Synthesiser.