io.elevator.building

Class ControlPanel.MaintenanceControlPanel

java.lang.Object

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

io.elevator.building.ControlPanel.MaintenanceControlPanel

Enclosing class:

ControlPanel<ButtonType>

public static class ControlPanel.MaintenanceControlPanel
extends ControlPanel<java.lang.Integer>

The driver representation for a maintenance control panel, to keep track of everything The parent list of buttons represents the floor buttons

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
MaintenanceControlPanel(int numOfFloors, java.lang.Object floorChime, java.lang.Object emergencyChime, java.util.List<EnvironmentSensor.BooleanSensor> sensors, java.util.List<ControlPanel.FloorControlPanel> floors) The ControlPanel mainButtonsOnPanel stores the floor buttons [null, 1, ..., n] so that the button at index 1 will send you to floor 1.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.Object>	flatten() Flattens this object's components into a single list
java.util.List<java.lang.Object>	getComponents() The stored list of components of this Component wrapper
Indicator.ArrivalIndicator	getCurrDirDownIndicator() If active, represents that this cabin is traveling down
Indicator.ArrivalIndicator	getCurrDirUpIndicator() If active, represents that the cabin is traveling up
Indicator.FloorIndicator	getCurrFloorIndicator() If active, displays the current or next landing the cabin is stopped at or passing
Indicator.DoorIndicator	getDoorIndicator() If active, represents that the doors of the cabin are open
Indicator.EmergencyIndicator	getEmergencyModeIndicator() If active, represents that the cabin is in emergency mode.
java.util.List<EnvironmentSensor>	getSensors() A list of all the sensors connected to the elevator system, in order to display their status
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
java.lang.String	toString()
ControlPanel.MaintenanceControlPanel	updateDoorIndicator(boolean doorsOpen) Updates the door indicator relative to the received state

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

MaintenanceControlPanel

public MaintenanceControlPanel(int numOfFloors,
                               java.lang.Object floorChime,
                               java.lang.Object emergencyChime,
                               java.util.List<EnvironmentSensor.BooleanSensor> sensors,
                               java.util.List<ControlPanel.FloorControlPanel> floors)

The ControlPanel mainButtonsOnPanel stores the floor buttons [null, 1, ..., n] so that the button at index 1 will send you to floor 1. This is not stored as a 0 button so it is obvious it has no input.

Parameters:

numOfFloors - the number of floors in a building (should be 2 to n)

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

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

sensors - List of all sensors for the elevator

floors - List of all floors for the elevator

Method Detail

getCurrDirUpIndicator

public final Indicator.ArrivalIndicator getCurrDirUpIndicator()

If active, represents that the cabin is traveling up

Returns:

the currDirUpIndicator

getCurrDirDownIndicator

public final Indicator.ArrivalIndicator getCurrDirDownIndicator()

If active, represents that this cabin is traveling down

Returns:

the currDirDownIndicator

getCurrFloorIndicator

public final Indicator.FloorIndicator getCurrFloorIndicator()

If active, displays the current or next landing the cabin is stopped at or passing

Returns:

the currFloorIndicator

getEmergencyModeIndicator

public final Indicator.EmergencyIndicator getEmergencyModeIndicator()

If active, represents that the cabin is in emergency mode. This is the "activate emergency mode" button for the Maintenance Control Panel. Software will need to see if this is lit and, if so, trigger emergency mode (possibly by triggering the fire sensor.)

Returns:

the emergencyModeIndicator

getDoorIndicator

public final Indicator.DoorIndicator getDoorIndicator()

If active, represents that the doors of the cabin are open

Returns:

the doorIndicator

getSensors

public final java.util.List<EnvironmentSensor> getSensors()

A list of all the sensors connected to the elevator system, in order to display their status

Returns:

the sensors

updateDoorIndicator

public ControlPanel.MaintenanceControlPanel updateDoorIndicator(boolean doorsOpen)

Updates the door indicator relative to the received state

Parameters:

doorsOpen - true if the doors are open

Returns:

this MCP

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.Integer>

Returns:

The list of this object's components

toString

public java.lang.String toString()

Overrides:

toString in class ControlPanel<java.lang.Integer>

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