fr.emn.reactiveinput.devices
Class FStdInput

java.lang.Object
  fr.emn.reactiveinput.devices.FStdInput

All Implemented Interfaces:

DeviceFolder

public class FStdInput

extends java.lang.Object

implements DeviceFolder

Folder containing a set of standard input devices

Note: "standard" does not mean that those devices will be available in all environments.

Field Summary

static DConst	constant
static DGestureCommand	gesturecommand
static DAWTKeyboard	keyboard
static DSpeechCommand	speechcommand
static DTick	tick
static DTime	time
static DVirtualUser	virtualUser

Constructor Summary

FStdInput()

Method Summary

DeviceDescriptor	getDefaultDescriptor() Returns a descriptor telling all possible devices this folder can contain in all possible environments (DDFolder not included).
DeviceDescriptor	getDefaultDescriptor(Device device) Returns the descriptor that will be used to build device's default signature.
java.lang.String	getName()
DeviceFolderContainer	getParent() Allows this folder to be added to a parent folder.
Device[]	getPrototypes() getDevices method comment.
void	setParent(DeviceFolderContainer newParent) Allows this folder to be added to a parent folder.

Methods inherited from class java.lang.Object

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

Field Detail

constant

public static final DConst constant

tick

public static final DTick tick

keyboard

public static final DAWTKeyboard keyboard

speechcommand

public static final DSpeechCommand speechcommand

gesturecommand

public static final DGestureCommand gesturecommand

time

public static final DTime time

virtualUser

public static final DVirtualUser virtualUser

Constructor Detail

FStdInput

public FStdInput()

Method Detail

getDefaultDescriptor

public DeviceDescriptor getDefaultDescriptor()

Description copied from interface: DeviceFolder

Returns a descriptor telling all possible devices this folder can contain in all possible environments (DDFolder not included).

Returns DDAny if this descriptor can contain every kind of device, or returns a more restrictive DeviceDescriptor defining the particular kind of devices associated with this folder.

Specified by:

getDefaultDescriptor in interface DeviceFolder

getDefaultDescriptor

public DeviceDescriptor getDefaultDescriptor(Device device)

Description copied from interface: DeviceFolder

Returns the descriptor that will be used to build device's default signature.

The device signature is used to serialize the device, i.e. retreive it in further executions of the virtual machine. The default signature of the device D from folder F is given by the combination (DDAnd) of three descriptors (See getDefaultSignature() method in DescriptorManager class):

1) new DDFolder(F)

2) F.getDefaultDescriptor()

3) F.getDefaultDescriptor(D)

Two devices with the same signature are equivalent in functionnality. Device equivalence must be defined as restrictive as possible. However, this method must only return information that is useful to identify the device inside the folder.

For example, if all devices of the same class are equivalent for a given folder (as in standard.processors folder), you can return a class descriptor (DDClass). However, in folders that provide devices of the same class with different functionnalities, you must use an alternate method for identifying them (such as their name, or other properties).

Note1: When possible, move factorizable descriptors in getDefaultDescriptor(void) method.

Note2: Do not include descriptors that are already defined in getDefaultDescriptor(void).

Specified by:

getDefaultDescriptor in interface DeviceFolder

getName

public java.lang.String getName()

Specified by:

getName in interface DeviceFolder

getParent

public DeviceFolderContainer getParent()

Description copied from interface: DeviceFolder

Allows this folder to be added to a parent folder.

Specified by:

getParent in interface DeviceFolder

getPrototypes

public Device[] getPrototypes()

getDevices method comment.

Specified by:

getPrototypes in interface DeviceFolder

setParent

public void setParent(DeviceFolderContainer newParent)

Description copied from interface: DeviceFolder

Allows this folder to be added to a parent folder.

Specified by:

setParent in interface DeviceFolder