io.elevator.components

Class FiremanKeyhole

java.lang.Object

io.elevator.components.FiremanKeyhole

All Implemented Interfaces:

Drawable, EnvironmentSensor.EmergencyHardware

public class FiremanKeyhole
extends java.lang.Object
implements EnvironmentSensor.EmergencyHardware, Drawable

Represents the driver for a physical fireman keyhole, having three states and placement data. This is the passive implementation of a Fireman Keyhole

Author:

Kage Weiss

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FiremanKeyhole.KeyState Represents the three possible states a Fireman Keyhole can be placed in and whether each state is indicative of emergency operation: OFF, ON, HOLD_BYPASS

Constructor Summary

Constructors

Constructor and Description
FiremanKeyhole(boolean onLanding) Crates a basic Fireman Keyhole, set to the Off position

Method Summary

Modifier and Type	Method and Description
javafx.scene.image.ImageView	getRepresentation() Gets the reference to an object of type ImageView in which this Drawable stores its representation.
FiremanKeyhole.KeyState	getState()
boolean	isAnEmergency()
boolean	isOnLanding()
Drawable	setImageView(javafx.scene.image.ImageView representation) Sets the reference to an object of type ImageView into which this Drawable should store its representation.
FiremanKeyhole	setState(FiremanKeyhole.KeyState state)
FiremanKeyhole	toggleState() Toggles the state of the fire key
java.lang.String	toString()
void	triggerEmergency()
Drawable	updateRepresentation() Updates the stored reference with a representation that represents the state of this Drawable

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FiremanKeyhole

public FiremanKeyhole(boolean onLanding)

Crates a basic Fireman Keyhole, set to the Off position

Parameters:

onLanding - whether the keyhole is installed in the exterior of a landing

Method Detail

getState

public FiremanKeyhole.KeyState getState()

Returns:

the current state of this keyhole

setState

public FiremanKeyhole setState(FiremanKeyhole.KeyState state)

Parameters:

state - the state to set

Returns:

this keyhole

toggleState

public FiremanKeyhole toggleState()

Toggles the state of the fire key

Returns:

this keyhole

isOnLanding

public boolean isOnLanding()

Returns:

Whether this keyhole is installed on a landing or in the cabin

isAnEmergency

public boolean isAnEmergency()

Specified by:

isAnEmergency in interface EnvironmentSensor.EmergencyHardware

setImageView

public Drawable setImageView(javafx.scene.image.ImageView representation)

Description copied from interface: Drawable

Sets the reference to an object of type ImageView into which this Drawable should store its representation. The passed reference should be stored, and an immediate call to updateRepresentation() should be made.

Specified by:

setImageView in interface Drawable

Parameters:

representation - The reference to the ImageView in which the representation of this Drawable should be placed

Returns:

this Drawable

getRepresentation

public javafx.scene.image.ImageView getRepresentation()

Description copied from interface: Drawable

Gets the reference to an object of type ImageView in which this Drawable stores its representation.

Specified by:

getRepresentation in interface Drawable

Returns:

The reference to the representation of this Drawable.

updateRepresentation

public Drawable updateRepresentation()

Description copied from interface: Drawable

Updates the stored reference with a representation that represents the state of this Drawable

Specified by:

updateRepresentation in interface Drawable

Returns:

this Drawable

triggerEmergency

public void triggerEmergency()

Specified by:

triggerEmergency in interface EnvironmentSensor.EmergencyHardware

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object