io.elevator.building

Class ControlPanel.FloorControlPanel

java.lang.Object

io.elevator.building.ControlPanel<java.lang.Boolean>

io.elevator.building.ControlPanel.FloorControlPanel

All Implemented Interfaces:

Drawable, java.lang.Comparable<ControlPanel.FloorControlPanel>

Enclosing class:

ControlPanel<ButtonType>

public static class ControlPanel.FloorControlPanel
extends ControlPanel<java.lang.Boolean>
implements java.lang.Comparable<ControlPanel.FloorControlPanel>, Drawable

The driver representation for an on-landing control panel, having 2x ArrivalIndicator, a FiremanKeyhole, and Buttons for placing calls

Author:

Kage Weiss

Nested Class Summary

Nested classes/interfaces inherited from class io.elevator.building.ControlPanel

ControlPanel.CabinControlPanel, ControlPanel.FloorControlPanel, ControlPanel.MaintenanceControlPanel

Constructor Summary

Constructors

Constructor and Description
FloorControlPanel(int floorNumber, boolean up, boolean down, java.lang.Object floorChime) Creates a basic landing control panel

Method Summary

Modifier and Type	Method and Description
int	compareTo(ControlPanel.FloorControlPanel other)
java.util.List<java.lang.Object>	flatten() Flattens this object's components into a single list
EnvironmentSensor.AlignmentSensor	getAlignmentSensor() Reports whether a cabin is aligned with this floor
Buttons<java.lang.Boolean>	getCallButtonDown() Requests the cabin stop at this landing to travel down
Buttons<java.lang.Boolean>	getCallButtonUp() Requests the cabin stop at this landing to travel up
java.util.List<java.lang.Object>	getComponents() The stored list of components of this Component wrapper
Indicator.ArrivalIndicator	getCurrDirDownIndicator() If active, when cabin opens doors on a floor, represents that the cabin is traveling down
Indicator.ArrivalIndicator	getCurrDirUpIndicator() If active, when cabin opens doors on a floor, represents that the cabin is traveling up
EnvironmentSensor.FireSensor	getFireSensor()
int	getFloorNumber() The number of the floor on which this panel is installed
javafx.scene.image.ImageView	getRepresentation() Gets the reference to an object of type ImageView in which this Drawable stores its representation.
io.elevator.building.Component	setComponents(java.util.List<java.lang.Object> components) Sets the stored list of this Component wrapper's components to be the passed param
io.elevator.building.Component	setComponents(java.lang.Object... components) Sets the stored list of this Component wrapper's components to be the passed params
Drawable	setImageView(javafx.scene.image.ImageView representation) Sets the reference to an object of type ImageView into which this Drawable should store its representation.
java.lang.String	toString()
Drawable	updateRepresentation() Updates the stored reference with a representation that represents the state of this Drawable
Drawable	updateRepresentation(boolean doorsOpen) Allows the representation to be updated from the MCP

Methods inherited from class io.elevator.building.ControlPanel

getFireKey, getMainButtonsOnPanel

Methods inherited from class java.lang.Object

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

Constructor Detail

FloorControlPanel

public FloorControlPanel(int floorNumber,
                         boolean up,
                         boolean down,
                         java.lang.Object floorChime)

Creates a basic landing control panel

Parameters:

floorNumber - the floor number for this landing

up - whether there is an up button (for example, the top floor does not have one)

down - whether there is an down button (for example, the bottom floor does not have one)

floorChime - The chime (or chimes) to play when at a floor

Method Detail

getCurrDirUpIndicator

public final Indicator.ArrivalIndicator getCurrDirUpIndicator()

If active, when cabin opens doors on a floor, represents that the cabin is traveling up

Returns:

the currDirUpIndicator

getCurrDirDownIndicator

public final Indicator.ArrivalIndicator getCurrDirDownIndicator()

If active, when cabin opens doors on a floor, represents that the cabin is traveling down

Returns:

the currDirDownIndicator

getCallButtonUp

public final Buttons<java.lang.Boolean> getCallButtonUp()

Requests the cabin stop at this landing to travel up

Returns:

the callButtonUp

getCallButtonDown

public final Buttons<java.lang.Boolean> getCallButtonDown()

Requests the cabin stop at this landing to travel down

Returns:

the callButtonDown

getAlignmentSensor

public final EnvironmentSensor.AlignmentSensor getAlignmentSensor()

Reports whether a cabin is aligned with this floor

Returns:

the alignmentSensor

getFireSensor

public final EnvironmentSensor.FireSensor getFireSensor()

Returns:

the fireSensor

getFloorNumber

public final int getFloorNumber()

The number of the floor on which this panel is installed

Returns:

the floorNumber

compareTo

public int compareTo(ControlPanel.FloorControlPanel other)

Specified by:

compareTo in interface java.lang.Comparable<ControlPanel.FloorControlPanel>

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

updateRepresentation

public Drawable updateRepresentation(boolean doorsOpen)

Allows the representation to be updated from the MCP

Parameters:

doorsOpen - true if the doors are open

Returns:

this Drawable

flatten

public java.util.List<java.lang.Object> flatten()

Flattens this object's components into a single list

Overrides:

flatten in class ControlPanel<java.lang.Boolean>

Returns:

The list of this object's components

toString

public java.lang.String toString()

Overrides:

toString in class ControlPanel<java.lang.Boolean>

setComponents

public io.elevator.building.Component setComponents(java.lang.Object... components)

Sets the stored list of this Component wrapper's components to be the passed params

Parameters:

components - The array of components to add

Returns:

This Component wrapper

setComponents

public io.elevator.building.Component setComponents(java.util.List<java.lang.Object> components)

Sets the stored list of this Component wrapper's components to be the passed param

Parameters:

components - The list of components to add

Returns:

This Component wrapper

getComponents

public java.util.List<java.lang.Object> getComponents()

The stored list of components of this Component wrapper

Returns:

The stored list of this object's components