stella.roof
Interface Sheltering

All Superinterfaces:

StatusProviding

All Known Subinterfaces:

DomeOperating, RoofOperating

All Known Implementing Classes:

AbstractShelter, DomeReceiver, RoofReceiver

public interface Sheltering
extends StatusProviding

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

boolean	close(boolean auto) Directly closes all roofs.
Date	getLastCloseTime() Returns the date of the last shut time if the roof is currently shut.
Date	getLastOpenTime() Returns the date of the last open time if the roof is currently open.
boolean	isClosed() Returns true if the dome is entirely closed.
boolean	isOpen() Returns true if the dome is entirely open.
boolean	open(boolean auto) Directly opens all roofs.

Methods inherited from interface util.StatusProviding

provideStatus

Method Detail

isOpen

boolean isOpen()

Returns true if the dome is entirely open. If this method is called during the opening/closing cycle, false should be returned.

isClosed

boolean isClosed()

Returns true if the dome is entirely closed. If this method is called during the opening/closing cycle, false should be returned.

getLastOpenTime

Date getLastOpenTime()

Returns the date of the last open time if the roof is currently open. If the roof is closed, null should be retunred.

getLastCloseTime

Date getLastCloseTime()

Returns the date of the last shut time if the roof is currently shut. If the roof is open, null should be retunred.

open

boolean open(boolean auto)

Directly opens all roofs. Blocks until the roof is open.

Parameters:

auto - True, if standard procedure (no emergency, like in automated mode).

Returns:

True if opening was successful.

close

boolean close(boolean auto)

Directly closes all roofs. Blocks until the roof is closed.

Parameters:

auto - True, if standard procedure (no emergency, like in automated mode).

Returns:

True if closing was successful