fr.emn.reactiveinput.devices
Class DMidiIn

java.lang.Object
  fr.emn.reactiveinput.AbstractDevice
      fr.emn.reactiveinput.devices.DMidiIn

All Implemented Interfaces:

Device, Processor

public class DMidiIn

extends AbstractDevice

Title: Input Configurator Description: Copyright: Copyright (c) 2001 Company: Ecole des Mines de Nantes

Version:

1.0

Author:

Pierre Dragicevic

Field Summary

Out[]	ctrl_val
Out	kbd_ch
Out	kbd_key
Out	kbd_pressed
Out	kbd_vel
Out	ppress_ch
Out	ppress_key
Out	ppress_val
Out	press_ch
Out	press_key
Out	press_val
Out	prg_ch
Out	prg_num
Out	sysex
Out	wheel_ch
Out	wheel_val

Fields inherited from class fr.emn.reactiveinput.AbstractDevice

currIndex, ins, outs

Fields inherited from interface fr.emn.reactiveinput.Device

AUTO_PROPERTIES

Constructor Summary

DMidiIn()

DMidiIn(java.lang.String name, javax.sound.midi.MidiDevice mididev)

Method Summary

void	close() Add closing code here if needed.
Device	copy() Is isCopiable() returns true, copies the device by calling DeviceUtilities.defaultCopy().
boolean	hasExternalInput() Specifies whether this device has external (implicit) input or not.
Processor	open(OpenContext context) Subclass this method if you want to specialize data processing, or if you want to perform some initializations before running the device.
void	update() Updates device's output values.

Methods inherited from class fr.emn.reactiveinput.AbstractDevice

addIn, addIn, addOut, doDisable, doEnable, finalize, getError, getIndex, getInfo, getIns, getName, getOuts, getProperties, hasExternalOutput, init, insertAt, insertAtEnd, insertBefore, isCopiable, isEnabled, isOpenable, setEnabled, setInfo, setInfo, setLastError, setName

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

kbd_pressed

public final Out kbd_pressed

kbd_key

public final Out kbd_key

kbd_vel

public final Out kbd_vel

kbd_ch

public final Out kbd_ch

ppress_key

public final Out ppress_key

ppress_val

public final Out ppress_val

ppress_ch

public final Out ppress_ch

press_key

public final Out press_key

press_val

public final Out press_val

press_ch

public final Out press_ch

ctrl_val

public final Out[] ctrl_val

prg_num

public final Out prg_num

prg_ch

public final Out prg_ch

wheel_val

public final Out wheel_val

wheel_ch

public final Out wheel_ch

sysex

public final Out sysex

Constructor Detail

DMidiIn

public DMidiIn()

DMidiIn

public DMidiIn(java.lang.String name,
               javax.sound.midi.MidiDevice mididev)

Method Detail

copy

public Device copy()

Description copied from class: AbstractDevice

Is isCopiable() returns true, copies the device by calling DeviceUtilities.defaultCopy(). Returns null if isCopiable() returns false.

Subclass this method if you want to provide another strategy.

Specified by:

copy in interface Device

Overrides:

copy in class AbstractDevice

hasExternalInput

public boolean hasExternalInput()

Description copied from class: AbstractDevice

Specifies whether this device has external (implicit) input or not. Returns false by default.

Return false if the device is deterministic from the data & time points of view, i.e. if its output production only depend on the explicit input history (input slots) and device's initial configuration. This is the case of most of the processing devices.

Return true if output values not only depend on the values of input slots, or if output production takes undefined time. Examples of devices with external input are input peripherals and asynchronous devices.

This method is used by the reactive machine to determine if this device is triggered by its input slots, or if it must be triggered continuously (i.e. each tick). This method can also be used by the editor for the device's graphical representation.

Specified by:

hasExternalInput in interface Device

Overrides:

hasExternalInput in class AbstractDevice

open

public Processor open(OpenContext context)

Description copied from class: AbstractDevice

Subclass this method if you want to specialize data processing, or if you want to perform some initializations before running the device.

By default, open() does nothing and returns the device itself as the Processor (or null if it is not openable): AbstractDevice implements both Device and Processor interfaces, so that you can add processing code directly into the device.

If you want to add specialization features, subclass this method to return a specific processor implementation depending on your device configuration.

Example :

public Processor getProcessor() { if (super.open() == null) return null; // Select the right processor if (in2.isValid()) { return new twoParamProcessor(in1, in2, out); else return new oneParamProcessor(in1, out); }

In this method, you may also perform all necessary pre-running initialization. If initialization fails, return null even if isOpenable() returns true.

In all cases, return null if isOpenable() returns false.

Specified by:

open in interface Device

Overrides:

open in class AbstractDevice

See Also:

Processor, Device.open()

close

public void close()

Description copied from class: AbstractDevice

Add closing code here if needed.

Specified by:

close in interface Device

Overrides:

close in class AbstractDevice

update

public void update()

Description copied from class: AbstractDevice

Updates device's output values.

Subclass init() and update() methods if you want the device to process the data itself. Otherwise, subclass getProcessor() method to use extern processors.

Specified by:

update in interface Processor

Overrides:

update in class AbstractDevice

See Also:

Processor.update()