Package jmri.implementation

Class DefaultLightControl

java.lang.Object

jmri.implementation.DefaultLightControl

All Implemented Interfaces:

LightControl

public class DefaultLightControl
extends Object
implements LightControl

Each LightControl object is linked to a specific Light, and provides one of the controls available for switching the Light ON/OFF in response to time or events occurring on the layout.

Each LightControl holds the information for one control of the parent Light.

Each Light may have as many controls as desired by the user. It is the user's responsibility to ensure that the various control mechanisms do not conflict with one another.

Available control types are those defined in the Light.java interface. Control types: SENSOR_CONTROL FAST_CLOCK_CONTROL TURNOUT_STATUS_CONTROL TIMED_ON_CONTROL TWO_SENSOR_CONTROL

This file is part of JMRI.

JMRI is free software; you can redistribute it and/or modify it under the terms of version 2 of the GNU General Public License as published by the Free Software Foundation. See the "COPYING" file for a copy of this license.

JMRI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	_controlSensorSense
protected int	_timeOnDuration

Constructor Summary

Constructors

Constructor	Description
DefaultLightControl()	Main constructor methods
DefaultLightControl(Light l)
DefaultLightControl(LightControl lc)	Create a New LightControl from existing, for use when editing a LightControl

Method Summary

Modifier and Type	Method	Description
void	activateLightControl()	Activates a Light Control by control type.
boolean	areFollowerTimesFaulty(List<LightControl> compareList)	Check to see if we have the FastClock Follower has unique times for a single Light.
void	deactivateLightControl()	Deactivates a LightControl by control type.
boolean	equals(Object o)	Test if a LightControl is equal to this one
String	getControlSensor2Name()	Get the Second Sensor name.
String	getControlSensorName()	Get the Sensor 1 name for 1 and 2 Sensor Control Types.
int	getControlSensorSense()	Get the Sensor State used by the 1 Sensor Control
String	getControlTimedOnSensorName()	Get the Timed On Trigger Sensor name.
String	getControlTurnoutName()	Get the LightControl Turnout Name.
int	getControlTurnoutState()	Get the LightControl Turnout Name.
int	getControlType()	Get the control type used by the Control
String	getDescriptionText(String lightName)	Get a Textual Description eg.
int	getFastClockOffCombined()	Get the Fast Clock Off Hours and Minutes Combined Convenience method of separate getFastClockOnHour() and getFastClockOnMin()
int	getFastClockOffHour()	Get the Fast Clock Off Hour.
int	getFastClockOffMin()	Get the Fast Clock Off Minute.
int	getFastClockOnCombined()	Get the Fast Clock On Hours and Minutes Combined Convenience method of separate getFastClockOnHour() and getFastClockOnMin()
int	getFastClockOnHour()	Get the Fast Clock On Hour.
int	getFastClockOnMin()	Get the Fast Clock On Minute.
int	getTimedOnDuration()	Get the Timed On Control Duration
String	getTimedSensorName()	Get the Timed On Trigger Sensor name.
int	hashCode()
boolean	onOffTimesFaulty()	Check to see if we have the FastClock Follower has unique times for a single Light Control.
void	setControlSensor2Name(String sensorName)	Set Sensor 2 used by the 2 Sensor Control Does NOT update any changelisteners
void	setControlSensorName(String sensorName)	Set Sensor 1 used by the 1 Sensor and 2 Sensor Control Does NOT update any changelisteners If Sensor not present and name not empty, is provided by the SensorManager when #activateLightControl() is called
void	setControlSensorSense(int sense)	Set the Sensor State used by the Control Does NOT update any changelisteners
void	setControlTimedOnSensorName(String sensorName)	Set Sensor used by the Timed On Control Does NOT update any changelisteners
void	setControlTurnout(String turnoutName)	Set the Turnout used by the Control Does NOT update any changelisteners
void	setControlTurnoutState(int state)	Set the Turnout State used by the Control Does NOT update any changelisteners
void	setControlType(int type)	Set the control type used by the Control Does NOT update any changelisteners
void	setFastClockControlSchedule(int onHour, int onMin, int offHour, int offMin)	Set a Fast Clock LightControl Schedule.
void	setParentLight(Light l)	Set Light to control Does NOT update any changelisteners
void	setTimedOnDuration(int duration)	Set Duration used by the Timed On Control Does NOT update any changeListeners
protected void	twoSensorChanged()	Internal routine for handling sensor changes for the 2 Sensor Control Type

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

_controlSensorSense

protected int _controlSensorSense

_timeOnDuration

protected int _timeOnDuration

Constructor Details

DefaultLightControl

public DefaultLightControl()

Main constructor methods

DefaultLightControl

public DefaultLightControl(Light l)

DefaultLightControl

public DefaultLightControl(@Nonnull
 LightControl lc)

Create a New LightControl from existing, for use when editing a LightControl

Parameters:

lc - the LightControl to be copied

Method Details

equals

public boolean equals(Object o)

Test if a LightControl is equal to this one

Overrides:

equals in class Object

Parameters:

o - the LightControl object to be checked

Returns:

True if the LightControl is equal, else false

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getControlType

public int getControlType()

Get the control type used by the Control

Specified by:

getControlType in interface LightControl

Returns:

the Control Type, eg. FAST_CLOCK_CONTROL

setControlType

public void setControlType(int type)

Set the control type used by the Control Does NOT update any changelisteners

Specified by:

setControlType in interface LightControl

Parameters:

type - the Control Type, eg. FAST_CLOCK_CONTROL

setControlSensorName

public void setControlSensorName(String sensorName)

Set Sensor 1 used by the 1 Sensor and 2 Sensor Control Does NOT update any changelisteners If Sensor not present and name not empty, is provided by the SensorManager when #activateLightControl() is called

Specified by:

setControlSensorName in interface LightControl

Parameters:

sensorName - the Sensor name

getControlSensorSense

public int getControlSensorSense()

Get the Sensor State used by the 1 Sensor Control

Specified by:

getControlSensorSense in interface LightControl

Returns:

Sensor.ACTIVE or Sensor.INACTIVE

getControlSensorName

public String getControlSensorName()

Get the Sensor 1 name for 1 and 2 Sensor Control Types.

Specified by:

getControlSensorName in interface LightControl

Returns:

If a Sensor is registered, returns the Sensor.getName() else the Sensor Name as set by #setControlSensorName

setControlSensorSense

public void setControlSensorSense(int sense)

Set the Sensor State used by the Control Does NOT update any changelisteners

Specified by:

setControlSensorSense in interface LightControl

Parameters:

sense - The state to react to, eg. Sensor.ACTIVE or Sensor.INACTIVE

getFastClockOnHour

public int getFastClockOnHour()

Get the Fast Clock On Hour.

Specified by:

getFastClockOnHour in interface LightControl

Returns:

On Hour value

getFastClockOnMin

public int getFastClockOnMin()

Get the Fast Clock On Minute.

Specified by:

getFastClockOnMin in interface LightControl

Returns:

On Minute value

getFastClockOnCombined

public int getFastClockOnCombined()

Get the Fast Clock On Hours and Minutes Combined Convenience method of separate getFastClockOnHour() and getFastClockOnMin()

Specified by:

getFastClockOnCombined in interface LightControl

Returns:

Total combined Minute value

getFastClockOffHour

public int getFastClockOffHour()

Get the Fast Clock Off Hour.

Specified by:

getFastClockOffHour in interface LightControl

Returns:

Off Hour value

getFastClockOffMin

public int getFastClockOffMin()

Get the Fast Clock Off Minute.

Specified by:

getFastClockOffMin in interface LightControl

Returns:

Off Minute value

getFastClockOffCombined

public int getFastClockOffCombined()

Get the Fast Clock Off Hours and Minutes Combined Convenience method of separate getFastClockOnHour() and getFastClockOnMin()

Specified by:

getFastClockOffCombined in interface LightControl

Returns:

Total combined Minute value

setFastClockControlSchedule

public void setFastClockControlSchedule(int onHour,
 int onMin,
 int offHour,
 int offMin)

Set a Fast Clock LightControl Schedule.

Specified by:

setFastClockControlSchedule in interface LightControl

Parameters:

onHour - Hour the Light should switch On

onMin - Minute the Light should switch On

offHour - Hour the Light should switch Off

offMin - Minute the Light should switch Off *

getControlTurnoutName

public String getControlTurnoutName()

Get the LightControl Turnout Name.

Specified by:

getControlTurnoutName in interface LightControl

Returns:

The Turnout name

setControlTurnout

public void setControlTurnout(String turnoutName)

Set the Turnout used by the Control Does NOT update any changelisteners

A Turnout of this name is provided by the TurnoutManager on LightControl Initialisation

Specified by:

setControlTurnout in interface LightControl

Parameters:

turnoutName - The Turnout name

getControlTurnoutState

public int getControlTurnoutState()

Get the LightControl Turnout Name.

Specified by:

getControlTurnoutState in interface LightControl

Returns:

The Turnout name

setControlTurnoutState

public void setControlTurnoutState(int state)

Set the Turnout State used by the Control Does NOT update any changelisteners

Specified by:

setControlTurnoutState in interface LightControl

Parameters:

state - Turnout state to act on, eg. Turnout.CLOSED or Turnout.THROWN

getTimedSensorName

public String getTimedSensorName()

Get the Timed On Trigger Sensor name.

Specified by:

getTimedSensorName in interface LightControl

Returns:

The Sensor Name as set by #setControlTimedOnSensorName

getControlTimedOnSensorName

public String getControlTimedOnSensorName()

Get the Timed On Trigger Sensor name.

Specified by:

getControlTimedOnSensorName in interface LightControl

Returns:

If a Sensor is registered, returns the Sensor.getName() else the Sensor Name as set by #setControlTimedOnSensorName

setControlTimedOnSensorName

public void setControlTimedOnSensorName(String sensorName)

Set Sensor used by the Timed On Control Does NOT update any changelisteners

Specified by:

setControlTimedOnSensorName in interface LightControl

Parameters:

sensorName - the Sensor name to be used for the On Trigger

getTimedOnDuration

public int getTimedOnDuration()

Get the Timed On Control Duration

Specified by:

getTimedOnDuration in interface LightControl

Returns:

duration in ms

setTimedOnDuration

public void setTimedOnDuration(int duration)

Set Duration used by the Timed On Control Does NOT update any changeListeners

Specified by:

setTimedOnDuration in interface LightControl

Parameters:

duration - in ms following the Sensor On Trigger

getControlSensor2Name

public String getControlSensor2Name()

Get the Second Sensor name. as used in the 2 Sensor Control Group.

Specified by:

getControlSensor2Name in interface LightControl

Returns:

If a 2nd Sensor is registered, returns the Sensor.getName() else the 2nd Sensor Name as set by #setControlSensor2Name

setControlSensor2Name

public void setControlSensor2Name(String sensorName)

Set Sensor 2 used by the 2 Sensor Control Does NOT update any changelisteners

Specified by:

setControlSensor2Name in interface LightControl

Parameters:

sensorName - the Sensor 2 name

setParentLight

public void setParentLight(Light l)

Set Light to control Does NOT update any changelisteners

Specified by:

setParentLight in interface LightControl

Parameters:

l - the Light object to control

getDescriptionText

public String getDescriptionText(String lightName)

Get a Textual Description eg. Light Control TestLight ON when TestSensor is Active eg. Light Control ON at 14:00, OFF at 15:00.

Specified by:

getDescriptionText in interface LightControl

Parameters:

lightName - the Light Name, can be empty.

Returns:

An I18N full-text description of thiscontrol

activateLightControl

public void activateLightControl()

Activates a Light Control by control type. This method tests the control type, and set up a control mechanism, appropriate for the control type. Adds PropertyChangeListeners to Sensors / Turnout / Fast Clock as necessary

Specified by:

activateLightControl in interface LightControl

twoSensorChanged

protected void twoSensorChanged()

Internal routine for handling sensor changes for the 2 Sensor Control Type

onOffTimesFaulty

public boolean onOffTimesFaulty()

Check to see if we have the FastClock Follower has unique times for a single Light Control.

Hour / Minute combination must be unique for each Light to avoid flicker.

Specified by:

onOffTimesFaulty in interface LightControl

Returns:

true if the clock on time equals the off time, otherwise false.

areFollowerTimesFaulty

public boolean areFollowerTimesFaulty(List<LightControl> compareList)

Check to see if we have the FastClock Follower has unique times for a single Light.

Hour / Minute combination must be unique for each Light to avoid flicker.

Specified by:

areFollowerTimesFaulty in interface LightControl

Parameters:

compareList - the ArrayList of other Light Controls to compare against

Returns:

true if there are multiple exact same times

deactivateLightControl

public void deactivateLightControl()

Deactivates a LightControl by control type. This method tests the control type, and deactivates the control mechanism, appropriate for the control type.

Specified by:

deactivateLightControl in interface LightControl