io.elevator.components

Class Indicator<T>

java.lang.Object

io.elevator.components.Indicator<T>

Type Parameters:

T - The type of data to be displayed in the indicator

Direct Known Subclasses:

Indicator.ArrivalIndicator, Indicator.DoorIndicator, Indicator.EmergencyIndicator, Indicator.FloorIndicator

public abstract class Indicator<T>
extends java.lang.Object

Represents the basics for an indicator as an output device having some data and an active/inactive state

Author:

Kage Weiss

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Indicator.ArrivalIndicator Represents the driver for a physical arrival indicator, to output the travel direction of a stopping cabin via light and sound
static class	Indicator.DataAndChime<D,C> Used as a way to enable storage of both data and audio in an @see#Indicator
static class	Indicator.DoorIndicator Represents the driver for a physical door state indicator, to output when the cabin doors are open
static class	Indicator.EmergencyIndicator Represents the driver for a physical emergency indicator, to output the given display and chime in case of emergency
static class	Indicator.FloorIndicator Represents the driver for a physical floor indicator, to output the current floor to cabin occupants

Constructor Summary

Constructors

Constructor and Description
Indicator(T data)
Indicator(T data, boolean active)

Method Summary

Modifier and Type	Method and Description
T	data()
boolean	isActive()
Indicator<T>	setActive(boolean active)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Indicator

public Indicator(T data)

Indicator

public Indicator(T data,
                 boolean active)

Method Detail

isActive

public boolean isActive()

Returns:

whether this Indicator is active

setActive

public Indicator<T> setActive(boolean active)

Parameters:

active - the active to set

Returns:

this Indicator

data

public T data()

Returns:

the data

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object