io.elevator.components

Class EnvironmentSensor.BooleanSensor

java.lang.Object

io.elevator.components.EnvironmentSensor

io.elevator.components.EnvironmentSensor.BooleanSensor

Direct Known Subclasses:

EnvironmentSensor.DoorSensor, EnvironmentSensor.MaxTolerance, EnvironmentSensor.MotorSensor

Enclosing class:

EnvironmentSensor

public static class EnvironmentSensor.BooleanSensor
extends EnvironmentSensor

This represents the base system for any sensor utilizing boolean output. For effectiveness, all boolean sensors have both their sensor report and active status

Author:

Kage Weiss

Nested Class Summary

Nested classes/interfaces inherited from class io.elevator.components.EnvironmentSensor

EnvironmentSensor.AlignmentSensor, EnvironmentSensor.BooleanSensor, EnvironmentSensor.CabinSpeedSensor, EnvironmentSensor.CabinWeightSensor, EnvironmentSensor.DoorSensor, EnvironmentSensor.EmergencyHardware, EnvironmentSensor.FireSensor, EnvironmentSensor.HazardSensor, EnvironmentSensor.MaxTolerance, EnvironmentSensor.MotorSensor, EnvironmentSensor.VibrationSensor

Constructor Summary

Constructors

Constructor and Description
BooleanSensor() Creates a basic BooleanSensor

Method Summary

Modifier and Type	Method and Description
boolean	conditionsNormal() Reports whether this sensor is experiencing normal conditions
EnvironmentSensor.BooleanSensor	experienceProblem() Set this sensor to inoperable
boolean	operational() Reports whether this sensor is operational
EnvironmentSensor.BooleanSensor	reset() Reset this sensor
java.lang.String	toString()
EnvironmentSensor.BooleanSensor	trigger() Set this sensor to display adverse conditions

Methods inherited from class java.lang.Object

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

Constructor Detail

BooleanSensor

public BooleanSensor()

Creates a basic BooleanSensor

Method Detail

operational

public boolean operational()

Reports whether this sensor is operational

Returns:

whether this sensor is operational

conditionsNormal

public boolean conditionsNormal()

Reports whether this sensor is experiencing normal conditions

Returns:

whether this sensor is experiencing normal conditions

reset

public EnvironmentSensor.BooleanSensor reset()

Reset this sensor

Returns:

this sensor

experienceProblem

public EnvironmentSensor.BooleanSensor experienceProblem()

Set this sensor to inoperable

Returns:

this sensor

trigger

public EnvironmentSensor.BooleanSensor trigger()

Set this sensor to display adverse conditions

Returns:

this sensor

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object