Isomet Modular Synthesiser (iMS) API  v1.4.2
iMS API
Classes | Public Member Functions | List of all members
iMS::IMSController Class Reference

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 FWVersionGetVersion () 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...
 

Detailed Description

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.

Author
Dave Cowan
Date
2015-11-03
Since
1.0

Member Function Documentation

const std::string& iMS::IMSController::Description ( ) const

Returns a descriptive string for the Controller.

Since
1.0
const Capabilities iMS::IMSController::GetCap ( ) const

Returns the Capabilities structure for the Controller.

Since
1.0
const FWVersion& iMS::IMSController::GetVersion ( ) const

Returns the firmware version for the Controller.

Since
1.0
const ImageTable& iMS::IMSController::ImgTable ( ) const

Returns the Image Index Table for the Controller.

Since
1.2
const bool iMS::IMSController::IsValid ( ) const

Returns true if the system scan successfully identified the Controller and initialised this Class.

Returns
true if the class contains valid data representing an attached iMS Controller
Since
1.0
const std::string& iMS::IMSController::Model ( ) const

Returns the short model number for the Controller.

Since
1.0

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