io

Interface Switch

All Superinterfaces:

Initializable, Parameter, PropertySupplying, Trigger, Triggering

All Known Implementing Classes:

AbstractRemoteSwitch, AbstractSwitch, BeckhoffLight, BeckhoffSwitch, CabinetSwitch, HumiditySwitch, LightSwitch, ModbusSwitch, MoxaSwitch, OneWireMultiSwitch, OneWireSwitch, RS485Switch, SwitchSkeleton, SwitchStub

public interface Switch
extends Trigger

A switch is a more specific implementation of a trigger. It allows turning on and off via its two methods turnOn(long) and turnOff().

Field Summary

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Method Summary

Modifier and Type	Method and Description
boolean	turnOff() Turns the switch off.
boolean	turnOn(long maxtime) Turns the switch on.

Methods inherited from interface globals.Parameter

get, getFormatted, getName, getString, set

Methods inherited from interface util.PropertySupplying

defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, parseObject, removeProperty, setObject, setProperty, stringProperties

Methods inherited from interface util.Initializable

init

Methods inherited from interface util.Triggering

getElapsedToggleTime, getLastToggleTime, getTrigger, isTrue, setTrigger, toggleTrigger

Method Detail

turnOn

boolean turnOn(long maxtime)

Turns the switch on. This might mean that hardwarewise a switch is turned, but may also be used only internally. Normally can devide to the Triggering.setTrigger(java.lang.Boolean) method.

Parameters:

maxtime - The maximum time the switch should be on (ms), zero for unlimited.

Returns:

True, if switch was successfully turned on.

turnOff

boolean turnOff()

Turns the switch off. This might mean that hardwarewise a switch is turned, but may also be used only internally. Normally can devide to the Triggering.setTrigger(java.lang.Boolean) method.

Returns:

True, if switch was successfully turned off.