fr.emn.reactiveinput.devices
Class DPrint

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

All Implemented Interfaces:

Device, MutableDevice, Processor

public class DPrint

extends AbstractMutableDevice

Print a slot to standard output.

Field Summary

In

in

Fields inherited from class fr.emn.reactiveinput.AbstractDevice

currIndex, ins, outs

Fields inherited from interface fr.emn.reactiveinput.Device

AUTO_PROPERTIES

Constructor Summary

DPrint()

DPrint(java.lang.String printLabel)

Method Summary

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.
java.lang.String	getPrintLabel()
boolean	hasExternalOutput() Specifies whether this device has external (implicit) output or not.
boolean	isOpenable() USE: Design.
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.
void	setPrintLabel(java.lang.String newPrintlabel)

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, close, copy, doDisable, doEnable, finalize, getError, getIndex, getInfo, getIns, getName, getOuts, getProperties, hasExternalInput, init, insertAt, insertAtEnd, insertBefore, isCopiable, isEnabled, setEnabled, setInfo, setInfo, setLastError, setName, update

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

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

Field Detail

in

public final In in

Constructor Detail

DPrint

public DPrint()

DPrint

public DPrint(java.lang.String printLabel)

Method Detail

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

getPrintLabel

public java.lang.String getPrintLabel()

Returns:

java.lang.String

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

Description copied from interface: Device

USE: Design.

This method returns false if the device is not openable because it is not properly configured (e.g. important input slots are not connected). Reactive machines ignore devices that are not openable.

Use this method if you want some pre-conditions to be verified before the execution of your device, inside init() and update() methods.

In the default method provided in DeviceUtilities, isOpenable() returns false if one or several obligatory input slots are not valid (see In.isValid()). You may add your own pre-conditions to this method.

Example :

public boolean isOpenable() { if (DeviceUtilities.defaultIsOpenable(this)) { // Verify default pre-conditions if (...) // Put additional pre-conditions here return true; } return false; }

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.

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

setPrintLabel

public void setPrintLabel(java.lang.String newPrintlabel)

Parameters:

newPrintlabel - java.lang.String