Isomet Modular Synthesiser (iMS) API
v1.4.2
iMS API
|
An object representing the overall configuration of an attached iMS System and permits applications to connect to it. More...
#include <include/IMSSystem.h>
Public Member Functions | |
IConnectionManager *const | Connection () const |
returns a pointer to an object which is the Connection through which all messages to the hardware go More... | |
void | Ctlr (const IMSController &) |
Add an iMS Controller to the System. Intended for internal library use. More... | |
void | Synth (const IMSSynthesiser &) |
Add an iMS Synthesiser to the System. Intended for internal library use. More... | |
const IMSController & | Ctlr () const |
Retrieve data about the iMS Controller. More... | |
const IMSSynthesiser & | Synth () const |
Retrieve data about the iMS Synthesiser. More... | |
const std::string & | ConnPort () const |
Returns a descriptive string representing the connection port on which the iMS System was discovered. More... | |
bool | operator== (IMSSystem const &rhs) const |
Tests for equality between two IMSSystem's. More... | |
Connect to / Disconnect from iMS Hardware | |
void | Connect () |
Attempts to establish a Connection to an iMS System. More... | |
void | Disconnect () |
Breaks a connection to an iMS System. More... | |
bool | Open () const |
Tests Connection Status. More... | |
An object representing the overall configuration of an attached iMS System and permits applications to connect to it.
void iMS::IMSSystem::Connect | ( | ) |
Attempts to establish a Connection to an iMS System.
Apart from scanning to identify attached iMS Systems (see ConnectionList::scan()), no interaction can occur with an iMS System until a connection has been established to it. This can be done by calling the Connect() function. Once established, the connection will remain open until Disconnect() is called.
IConnectionManager* const iMS::IMSSystem::Connection | ( | ) | const |
returns a pointer to an object which is the Connection through which all messages to the hardware go
const std::string& iMS::IMSSystem::ConnPort | ( | ) | const |
Returns a descriptive string representing the connection port on which the iMS System was discovered.
void iMS::IMSSystem::Ctlr | ( | const IMSController & | ) |
Add an iMS Controller to the System. Intended for internal library use.
const IMSController& iMS::IMSSystem::Ctlr | ( | ) | const |
void iMS::IMSSystem::Disconnect | ( | ) |
Breaks a connection to an iMS System.
Any existing connection to an iMS System can be terminated by calling the Disconenct() function. Any messages that are pending but not yet sent will be completed before closing the connection, so the application can be sure that any immediately preceding commands will be run to completion before the connection is closed.
bool iMS::IMSSystem::Open | ( | ) | const |
Tests Connection Status.
If an open connection exists to the iMS System, this function will return true
bool iMS::IMSSystem::operator== | ( | IMSSystem const & | rhs | ) | const |
Tests for equality between two IMSSystem's.
void iMS::IMSSystem::Synth | ( | const IMSSynthesiser & | ) |
Add an iMS Synthesiser to the System. Intended for internal library use.
const IMSSynthesiser& iMS::IMSSystem::Synth | ( | ) | const |