stella.roof

Interface RoofOperating

All Superinterfaces:

Sheltering, StatusProviding

All Known Implementing Classes:

RoofReceiver

public interface RoofOperating
extends Sheltering

An interface describing the functionality of a roof server. It allows installing of a driver object allowing the software to drive the roof hardware.
Concrete implementations should also provide the connecting part of a environment command launcher, see CommandLaunching.

Method Summary

Modifier and Type	Method and Description
void	clearLastError() Clears the last error event generated.
boolean	closeLeft() Directly closes the left roof.
boolean	closeRight() Directly closes the right roof.
ErrorEvent	getLastError(CommandEvent cmd) Returns the last error generated as a result of on of the open/close etc.
boolean	openLeft() Directly opens the left roof.
boolean	openRight() Directly opens the right roof.
boolean	powerOff() Directly powers down the roof.
boolean	powerOn() Directly powers up the roof.
boolean	resetLimit() Resets a limit switch failure.

Methods inherited from interface stella.roof.Sheltering

close, getLastCloseTime, getLastOpenTime, isClosed, isOpen, open

Methods inherited from interface util.StatusProviding

conciseStatus, extendedStatus

Method Detail

getLastError

ErrorEvent getLastError(CommandEvent cmd)

Returns the last error generated as a result of on of the open/close etc. commands. The result is transfered as an {link ErrorEvent}

clearLastError

void clearLastError()

Clears the last error event generated.

openLeft

boolean openLeft()

Directly opens the left roof. Blocks until the roof is open.

Returns:

True if opening was successful.

openRight

boolean openRight()

Directly opens the right roof. Blocks until the roof is open.

Returns:

True if opening was successful.

closeLeft

boolean closeLeft()

Directly closes the left roof. Blocks until the roof is closed.

Returns:

True if closing was successful

closeRight

boolean closeRight()

Directly closes the right roof. Blocks until the roof is closed.

Returns:

True if closing was successful

powerOn

boolean powerOn()

Directly powers up the roof.

Returns:

True on success

powerOff

boolean powerOff()

Directly powers down the roof.

Returns:

True on success

resetLimit

boolean resetLimit()

Resets a limit switch failure.