ControlPanel.CabinControlPanel

java.lang.Object
- io.elevator.building.ControlPanel<java.lang.Integer>
- - io.elevator.building.ControlPanel.CabinControlPanel

Enclosing class:

ControlPanel<ButtonType>
```
public static class ControlPanel.CabinControlPanel
extends ControlPanel<java.lang.Integer>
```
The driver representation for an in-cabin control panel
This class contains linking methods for controlling the cabin in reference to the hardware

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
`CabinControlPanel(int numOfFloors, java.lang.Object floorChime, java.lang.Object emergencyChime)` 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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ControlPanel.CabinControlPanel`	`closeDoors()` Sets the status of the doorSensor to reflect that the doors are closed.
`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
`Buttons<java.lang.Boolean>`	`getDoorCloseButton()` Signals the doors to close, may or may not be a placebo
`Buttons<java.lang.Boolean>`	`getDoorOpenButton()` Signals the doors to open
`EnvironmentSensor.DoorSensor`	`getDoorSensor()`
`Indicator.ArrivalIndicator`	`getDownIndicator()` If active, when cabin opens doors on a floor, represents that this cabin is traveling down
`Indicator.EmergencyIndicator`	`getEmergencyIndicator()` If active, represents that this cabin is in emergency mode
`EnvironmentSensor.FireSensor`	`getFireSensor()`
`Indicator.FloorIndicator`	`getFloorIndicator()` If active, displays the current or next landing the cabin is stopped at or passing
`Indicator.ArrivalIndicator`	`getUpIndicator()` If active, when cabin opens doors on a floor, represents that this cabin is traveling up
`ControlPanel.CabinControlPanel`	`openDoors()` Sets the status of the doorSensor to reflect that the doors are open.
`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
`ControlPanel.CabinControlPanel`	`setMCPDoorIndicator(ControlPanel.MaintenanceControlPanel mcp)` Sets the MaintenanceControlPanel DoorIndicator reference for update on DoorSensor change. Thank Anna for this one, I was going to let you figure it out as software
`java.lang.String`	`toString()`

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
  - CabinControlPanel
```
public CabinControlPanel(int numOfFloors,
                         java.lang.Object floorChime,
                         java.lang.Object emergencyChime)
```
    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
- Method Detail
  - getUpIndicator
```
public final Indicator.ArrivalIndicator getUpIndicator()
```
    If active, when cabin opens doors on a floor, represents that this cabin is traveling up
    
    Returns:
    
    the upIndicator
  - getDownIndicator
```
public final Indicator.ArrivalIndicator getDownIndicator()
```
    If active, when cabin opens doors on a floor, represents that this cabin is traveling down
    
    Returns:
    
    the downIndicator
  - getFloorIndicator
```
public final Indicator.FloorIndicator getFloorIndicator()
```
    If active, displays the current or next landing the cabin is stopped at or passing
    
    Returns:
    
    the floorIndicator
  - getEmergencyIndicator
```
public final Indicator.EmergencyIndicator getEmergencyIndicator()
```
    If active, represents that this cabin is in emergency mode
    
    Returns:
    
    the emergencyIndicator
  - getDoorOpenButton
```
public final Buttons<java.lang.Boolean> getDoorOpenButton()
```
    Signals the doors to open
    
    Returns:
    
    the doorOpenButton
  - getDoorCloseButton
```
public final Buttons<java.lang.Boolean> getDoorCloseButton()
```
    Signals the doors to close, may or may not be a placebo
    
    Returns:
    
    the doorCloseButton
  - getDoorSensor
```
public final EnvironmentSensor.DoorSensor getDoorSensor()
```
    Returns:
    
    the doorSensor
  - getFireSensor
```
public final EnvironmentSensor.FireSensor getFireSensor()
```
    Returns:
    
    the fireSensor
  - openDoors
```
public ControlPanel.CabinControlPanel openDoors()
```
    Sets the status of the doorSensor to reflect that the doors are open.
    
    Returns:
    
    this CCP
  - closeDoors
```
public ControlPanel.CabinControlPanel closeDoors()
```
    Sets the status of the doorSensor to reflect that the doors are closed.
    
    Returns:
    
    this CCP
  - setMCPDoorIndicator
```
public ControlPanel.CabinControlPanel setMCPDoorIndicator(ControlPanel.MaintenanceControlPanel mcp)
```
    Sets the MaintenanceControlPanel DoorIndicator reference for update on DoorSensor change.
    Thank Anna for this one, I was going to let you figure it out as software
    
    Parameters:
    
    mcp - the MCP having a DoorIndicator to update
    
    Returns:
    
    this CCP
  - 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

Class ControlPanel.CabinControlPanel

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class io.elevator.building.ControlPanel

Methods inherited from class java.lang.Object

Constructor Detail

CabinControlPanel

Method Detail

getUpIndicator

getDownIndicator

getFloorIndicator

getEmergencyIndicator

getDoorOpenButton

getDoorCloseButton

getDoorSensor

getFireSensor

openDoors

closeDoors

setMCPDoorIndicator

flatten

toString

setComponents

setComponents

getComponents