fr.emn.reactiveinput.devices
Class DWatcher

java.lang.Object
  fr.emn.reactiveinput.AbstractDevice
      fr.emn.reactiveinput.AbstractMutableDevice
          fr.emn.reactiveinput.devices.DWatcher

All Implemented Interfaces:

Device, MutableDevice, Processor

public class DWatcher

extends AbstractMutableDevice

A watcher example. (Add RemoveSlot functionalities)

Field Summary

In[]	ins
int	MAX_SLOTS
int	MIN_SLOTS

Fields inherited from class fr.emn.reactiveinput.AbstractDevice

currIndex, outs

Fields inherited from interface fr.emn.reactiveinput.Device

AUTO_PROPERTIES

Constructor Summary

DWatcher()

Method Summary

protected void	addSlots(int num, boolean dynamic)
void	close() Closes the device.
DeviceInfo	getDeviceInfo()
Slot[]	getMutationTriggers() Returns the mutation triggers for this mutable device, i.e. all input or output slots that trigger a mutation when it is connected to another type.
int	getNumSlots()
boolean	hasExternalOutput() Specifies whether this device has external (implicit) output or not.
boolean	isOpenable() This device has only optional slots (which allows "holes"), but is not considered openable if nothing is connected.
void	mutate() Performs a mutation on this device.
Processor	open(OpenContext context) Ensures that the device will be ready for processing or producing data, and returns the Processor object that will process data, or null if an error occured.
protected void	removeSlots(int num)
void	setNumSlots(int num) During deserialization, this is allows device to have the proper number of slots before being connected.
void	update() Updates device's output values.

Methods inherited from class fr.emn.reactiveinput.AbstractMutableDevice

addMutableIn, addMutableIn, addMutableIn, addMutableOut, addMutableOut, remove

Methods inherited from class fr.emn.reactiveinput.AbstractDevice

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.emn.reactiveinput.Device

copy, getError, getInfo, getIns, getName, getOuts, getProperties, hasExternalInput, isCopiable, setEnabled

Field Detail

MIN_SLOTS

public final int MIN_SLOTS

See Also:

Constant Field Values

MAX_SLOTS

public final int MAX_SLOTS

See Also:

Constant Field Values

ins

public final In[] ins

Constructor Detail

DWatcher

public DWatcher()

Method Detail

addSlots

protected void addSlots(int num,
                        boolean dynamic)

close

public void close()

Description copied from interface: Device

Closes the device. Called when the device is not used any more.

Deallocate resources here.

Specified by:

close in interface Device

Overrides:

close in class AbstractDevice

getDeviceInfo

public DeviceInfo getDeviceInfo()

getMutationTriggers

public Slot[] getMutationTriggers()

Description copied from class: AbstractMutableDevice

Returns the mutation triggers for this mutable device, i.e. all input or output slots that trigger a mutation when it is connected to another type.

Specified by:

getMutationTriggers in interface MutableDevice

Specified by:

getMutationTriggers in class AbstractMutableDevice

getNumSlots

public int getNumSlots()

hasExternalOutput

public boolean hasExternalOutput()

Description copied from interface: Device

Specifies whether this device has external (implicit) output or not.

Return false if the device has no border effects. Most of input and processing devices are in this case.

Return true if the device has border effects, such as graphical feedback, or control of some external value. Examples of devices with external output are application-interfacing devices and all user feedback devices.

This method can be used by the editor for the device's graphical representation. However this makes no difference for the reactive machine.

Specified by:

hasExternalOutput in interface Device

Overrides:

hasExternalOutput in class AbstractDevice

isOpenable

public boolean isOpenable()

This device has only optional slots (which allows "holes"), but is not considered openable if nothing is connected.

Specified by:

isOpenable in interface Device

Overrides:

isOpenable in class AbstractDevice

mutate

public void mutate()

Performs a mutation on this device. This method is called when a connection is made (or deleted) on a mutation trigger.

DWatcher creates a new slot if the last slot has been connected, or removes it if it has been disconnected.

Specified by:

mutate in interface MutableDevice

Specified by:

mutate in class AbstractMutableDevice

open

public Processor open(OpenContext context)

Description copied from interface: Device

Ensures that the device will be ready for processing or producing data, and returns the Processor object that will process data, or null if an error occured.

Some devices may need to perform some more or less heavy initialization (such as allocating resources or opening a stream) before being able to process or produce data. This is the case for most input devices, and some I/O and output devices. All these initializations must be done in the open() method.

Because these initializations are subject to fail, open() may return null even if isOpenable() returns true. In all cases, returning a non-null Processor means that the device is now able to process or produce data.

RE-OPENING A DEVICE:

Devices always stay open during reconfiguration, in order to avoid unnecessary deallocation and reallocation of resources. However, some devices will need to be re-open before re-starting the configuration. So open() is always called on all devices before re-starting.

If open() is called on a device that is already open, it may have no effect (and the current Processor is returned), or the device may be re-open if something has changed in its configuration.

Using a Processor as a return value allows the use of different processors, each adapted to a specific device configuration.

Specified by:

open in interface Device

Overrides:

open in class AbstractDevice

See Also:

Processor, Device.open()

removeSlots

protected void removeSlots(int num)

setNumSlots

public void setNumSlots(int num)

During deserialization, this is allows device to have the proper number of slots before being connected.

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