io.elevator.building

Class Hoistway

java.lang.Object

io.elevator.building.Hoistway

public class Hoistway
extends java.lang.Object

Represents the elevator hoistway contains sensors and control signals
This class contains linking methods for controlling the cabin in reference to the hardware

Author:

Kage Weiss

Constructor Summary

Constructors

Constructor and Description
Hoistway(java.util.List<ControlPanel.FloorControlPanel> floors) Creates a basic hoistway.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.Object>	flatten() Flattens this object's components into a single list
EnvironmentSensor.CabinSpeedSensor	getCabinSpeedSensor() The current cabin speed as driven by the motor
EnvironmentSensor.CabinWeightSensor	getCabinWeightSensor() The current cabin weight as lifted by the counterweight
java.util.List<java.lang.Object>	getComponents() The stored list of components of this Component wrapper
EnvironmentSensor.FireSensor	getFireSensor() The hoistway fire sensor
java.util.List<Indicator.FloorIndicator>	getFloorIndicators()
EnvironmentSensor.MotorSensor	getMotorSensor() The motor sensor
EnvironmentSensor.VibrationSensor	getVibrationSensor() Earthquake detection sensor
Hoistway	moveCabinDown() Signals the motor to let the occupants down
Hoistway	moveCabinUp() Signals the motor to pull the cabin up
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
Hoistway	setFloorIndicators(java.util.List<java.lang.Object> list) Sets the FloorIndicator references to update on cabin floor change. Thank Anna for this one, I was going to let you figure it out as software
Hoistway	stopCabin() Signals the motor to stop

Methods inherited from class java.lang.Object

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

Constructor Detail

Hoistway

public Hoistway(java.util.List<ControlPanel.FloorControlPanel> floors)

Creates a basic hoistway. Requires the list of floors on setup to accurately simulate alignment sensor triggers

Parameters:

floors - the list of all floors already setup

Method Detail

getMotorSensor

public final EnvironmentSensor.MotorSensor getMotorSensor()

The motor sensor

Returns:

the motorSensor

getFireSensor

public final EnvironmentSensor.FireSensor getFireSensor()

The hoistway fire sensor

Returns:

the fireSensor

getCabinSpeedSensor

public final EnvironmentSensor.CabinSpeedSensor getCabinSpeedSensor()

The current cabin speed as driven by the motor

Returns:

the cabinSpeedSensor

getCabinWeightSensor

public final EnvironmentSensor.CabinWeightSensor getCabinWeightSensor()

The current cabin weight as lifted by the counterweight

Returns:

the cabinWeightSensor

getVibrationSensor

public final EnvironmentSensor.VibrationSensor getVibrationSensor()

Earthquake detection sensor

Returns:

the vibrationSensor

getFloorIndicators

public java.util.List<Indicator.FloorIndicator> getFloorIndicators()

Returns:

the floorIndicators

moveCabinUp

public Hoistway moveCabinUp()
                     throws java.lang.Exception

Signals the motor to pull the cabin up

Returns:

This hoistway

Throws:

java.lang.Exception - When the motor is reversed without stopping or attempts to travel to a nonexistent floor

moveCabinDown

public Hoistway moveCabinDown()
                       throws java.lang.Exception

Signals the motor to let the occupants down

Returns:

This hoistway

Throws:

java.lang.Exception - When the motor is reversed without stopping or attempts to travel to a nonexistent floor

stopCabin

public Hoistway stopCabin()

Signals the motor to stop

Returns:

This hoistway

setFloorIndicators

public Hoistway setFloorIndicators(java.util.List<java.lang.Object> list)

Sets the FloorIndicator references to update on cabin floor change.
Thank Anna for this one, I was going to let you figure it out as software

Parameters:

list - the FloorIndicators to update

Returns:

this Hoistway

flatten

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

Flattens this object's components into a single list

Returns:

The list of this object's components

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