Isomet Modular Synthesiser (iMS) API  v1.4.2
iMS API
Class Hierarchy

Go to the graphical class hierarchy

This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 12]
 CiMS::AuxiliaryProvides auxiliary additional functions not directly related to Synthesiser operation
 CiMS::AuxiliaryEventsAll the different types of events that can be triggered by the Auxiliary class
 CiMS::IMSController::CapabilitiesReturns information about the capabilities of the Controller hardware
 CiMS::IMSSynthesiser::CapabilitiesReturns information about the capabilities of the Synthesiser hardware
 CiMS::CompensationEventsAll the different types of events that can be triggered by the Compensation and CompensationTableDownload classes
 CiMS::CompensationPointStores 4 data fields containing amplitude, phase, sync analogue and sync digital compensation data
 CiMS::CompensationPointSpecificationCompletely specifies the desired compensation at a spot frequency
 CiMS::ConnectionList::ConnectionConfigControls the behaviour of a Connection Module during its discovery process
 CiMS::ConnectionListCreates iMS Connection Interfaces and scans them to discover available iMS Systems
 CiMS::DDSScriptDownloadProvides a mechanism for transferring DDS Scripts into Filesystem memory
 CiMS::DDSScriptRegisterCreate a register write to send to the DDS IC
 CiMS::DegreesType Definition for all operations that require an angle specification in degrees
 CiMS::DequeBase< T >Template Class encapsulating a deque object and acting as a base deque class for other classes in the library to inherit from
 CiMS::DequeBase< CompensationPoint >
 CiMS::CompensationTableA table of CompensationPoints storing look-up data that can be transferred to memory in the Synthesiser
 CiMS::DequeBase< Image >
 CiMS::ImageGroupAn ImageGroup collects together multiple associated images and a single ImageSequence for controlling Image playback order
 CiMS::DequeBase< ImagePoint >
 CiMS::ImageA sequence of ImagePoints played out sequentially by the Controller and driven by the Synthesiser
 CiMS::DiagnosticsProvides a mechanism for retrieving diagnostics data about the attached iMS System
 CiMS::DiagnosticsEventsAll the different types of events that can be triggered by the Diagnostics class
 CiMS::FAPFAP (Frequency/Amplitude/Phase) triad stores the instantaneous definition of a single RF output
 CiMS::FileSystemManagerProvides user management operations for working with Synthesiser FileSystems
 CiMS::FileSystemTableEntryContains all the parameters that uniquely locate a File within the Synthesiser FileSystem
 CiMS::FileSystemTableViewerProvides a mechanism for viewing the FileSystemTable associated with an iMS System
 CiMS::FrequencyType Definition for all operations that require a frequency specification
 CiMS::kHzType Definition for all operations that require a frequency specification in kiloHertz
 CiMS::MHzType Definition for all operations that require a frequency specification in MegaHertz
 CiMS::FWVersionStores the version number of firmware running on iMS hardware
 CiMS::IBulkTransferInterface Specification class for sending large binary data objects to the iMS
 CiMS::CompensationTableDownloadProvides a mechanism for downloading and verifying Compensation Tables to a Synthesiser's Look-Up memory
 CiMS::ImageDownloadProvides a mechanism for downloading and verifying Images to a Controller's memory
 CiMS::ToneBufferDownloadProvides a mechanism for downloading ToneBuffer's to a Synthesiser's LTB memory
 CiMS::IEventHandlerInterface Class for an Event Handler to be defined in User Code and subscribed to library events
 CiMS::ImageDownloadEventsAll the different types of events that can be triggered by the ImageDownload class
 CiMS::ImagePlayerOnce an Image has been downloaded to Controller memory, ImagePlayer can be used to configure and begin playback
 CiMS::ImagePlayerEventsAll the different types of events that can be triggered by the ImagePlayer class
 CiMS::ImagePointStores 4 FAP Triads containing frequency, amplitude and phase data for 4 RF channels
 CiMS::ImageProjectAn ImageProject allows the user to organise their data and store it on the host computer
 CiMS::ImageSequenceEntryAn ImageSequenceEntry object can be created by application software to specify the parameters by which an Image is played back during an ImageSequence
 CiMS::ImageTableEntryAn ImageTableEntry is created by the SDK on connecting to an iMS System, one for each Image that is stored in Controller memory and allocated in the Image Index Table. Further ImageTableEntries are added to the table each time an Image is downloaded to the Controller
 CiMS::ImageTableViewerProvides a mechanism for viewing the ImageTable associated with an iMS System
 CiMS::IMSControllerStores Capabilities, Description, Model & Version Number of an iMS Controller
 CiMS::IMSOptionAn iMS Synthesiser can support one iMS Option, which adds an additional hardware function to the capabilities of the Synthesiser
 CiMS::IMSSynthesiserStores Capabilities, Description, Model & Version Number of an iMS Synthesiser
 CiMS::IMSSystemAn object representing the overall configuration of an attached iMS System and permits applications to connect to it
 CiMS::LibVersionAccess the version information for the API
 CiMS::ListBase< T >Template Class encapsulating a list object and acting as a base list class for other classes in the library to inherit from
 CiMS::ListBase< CompensationFunction >
 CiMS::CompensationFunctionListA List of CompensationFunction's used as a container by ImageProject
 CiMS::ListBase< CompensationPointSpecification >
 CiMS::CompensationFunctionClass for performing Compensation related functions with the Synthesiser
 CiMS::ListBase< ImageGroup >
 CiMS::ImageGroupListA List of ImageGroup's used as a container by ImageProject
 CiMS::ListBase< ImageSequenceEntry >
 CiMS::ImageSequenceAn ImageSequence object completely defines a sequence to be played back on an iMS Controller in terms by containing a list of ImageSequenceEntry 's plus a terminating action and optional value
 CiMS::ListBase< ToneBuffer >
 CiMS::ToneBufferListA List of ToneBuffer's used as a container by ImageProject
 CiMS::PercentType Definition for all operations that require a percentage specification
 CiMS::ImagePlayer::PlayConfigurationThis struct sets the attributes for the ImagePlayer to use when initiating an Image Playback
 CiMS::RFChannelType that represents the integer values 1, 2, 3 and 4, one each for the RF Channels of an iMS Synthesiser
 CiMS::SequenceManager::SeqConfigurationThis struct sets the attributes for the Sequence to use when initiating an Sequence Playback
 CiMS::SequenceDownloadThis class is a worker for transmitting an ImageSequence to an iMS Controller and joining it to the back of the sequence queue
 CiMS::SequenceEventsAll the different types of events that can be triggered by the SequenceManager class
 CiMS::SequenceManager
 CiMS::SignalPathControls Signal routing and other parameters related to the RF output signals
 CiMS::SignalPathEventsAll the different types of events that can be triggered by the SignalPath class
 CiMS::StartupConfigurationThe Synthesiser stores in its non-volatile memory a set of configuration values that are preloaded on startup
 CiMS::SystemFuncProvides System Management functions not directly related to RF signal generation or signal path control
 CiMS::SystemFuncEventsAll the different types of events that can be triggered by the SystemFunc class
 CiMS::ToneBufferAn array of 4-channel FAP Tones stored in memory on the Synthesiser
 CiMS::ToneBufferEventsAll the different types of events that can be triggered by the ToneBuffer and ToneBufferDownload classes
 CiMS::UserFileReaderProvides a mechanism for retrieving User File data from the Synthesiser FileSystem
 CiMS::UserFileWriterProvides a mechanism for committing User File data to the Synthesiser FileSystem
 CiMS::VelocityConfigurationSets the parameters required to control the operation of the Encoder Input / Velocity Compensation function