Isomet Modular Synthesiser (iMS) API
v1.4.2
iMS API
|
Stores Capabilities, Description, Model & Version Number of an iMS Controller. More...
#include <include/IMSSystem.h>
Classes | |
struct | Capabilities |
Returns information about the capabilities of the Controller hardware. More... | |
Public Member Functions | |
const Capabilities | GetCap () const |
Returns the Capabilities structure for the Controller. More... | |
const std::string & | Description () const |
Returns a descriptive string for the Controller. More... | |
const std::string & | Model () const |
Returns the short model number for the Controller. More... | |
const FWVersion & | GetVersion () const |
Returns the firmware version for the Controller. More... | |
const ImageTable & | ImgTable () const |
Returns the Image Index Table for the Controller. More... | |
const bool | IsValid () const |
Returns true if the system scan successfully identified the Controller and initialised this Class. More... | |
Stores Capabilities, Description, Model & Version Number of an iMS Controller.
An IMSController class is a member of the IMSSystem class and contains valid information about an iMS Controller if the ConnectionList::scan() function was able to successfully identify it.
The fields that can be read back to describe the controller can be used in Application code to select between Controllers, 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::IMSController::Description | ( | ) | const |
Returns a descriptive string for the Controller.
const Capabilities iMS::IMSController::GetCap | ( | ) | const |
Returns the Capabilities structure for the Controller.
const FWVersion& iMS::IMSController::GetVersion | ( | ) | const |
Returns the firmware version for the Controller.
const ImageTable& iMS::IMSController::ImgTable | ( | ) | const |
Returns the Image Index Table for the Controller.
const bool iMS::IMSController::IsValid | ( | ) | const |
Returns true if the system scan successfully identified the Controller and initialised this Class.
const std::string& iMS::IMSController::Model | ( | ) | const |
Returns the short model number for the Controller.