Interface LightControl
-
- All Known Implementing Classes:
DefaultLightControl
public interface 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.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
activateLightControl()
Activates a Light Control by control type.boolean
areFollowerTimesFaulty(java.util.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.java.lang.String
getControlSensor2Name()
Get the Second Sensor name.java.lang.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 Controljava.lang.String
getControlTimedOnSensorName()
Get the Timed On Trigger Sensor name.java.lang.String
getControlTurnoutName()
Get the LightControl Turnout Name.int
getControlTurnoutState()
Get the LightControl Turnout Name.int
getControlType()
Get the control type used by the Controljava.lang.String
getDescriptionText(java.lang.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 Durationjava.lang.String
getTimedSensorName()
Get the Timed On Trigger Sensor name.boolean
onOffTimesFaulty()
Check to see if we have the FastClock Follower has unique times for a single Light Control.void
setControlSensor2Name(java.lang.String sensorName)
Set Sensor 2 used by the 2 Sensor Control Does NOT update any changelistenersvoid
setControlSensorName(java.lang.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 calledvoid
setControlSensorSense(int sense)
Set the Sensor State used by the Control Does NOT update any changelistenersvoid
setControlTimedOnSensorName(java.lang.String sensorName)
Set Sensor used by the Timed On Control Does NOT update any changelistenersvoid
setControlTurnout(java.lang.String turnoutName)
Set the Turnout used by the Control Does NOT update any changelistenersvoid
setControlTurnoutState(int state)
Set the Turnout State used by the Control Does NOT update any changelistenersvoid
setControlType(int type)
Set the control type used by the Control Does NOT update any changelistenersvoid
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 changelistenersvoid
setTimedOnDuration(int duration)
Set Duration used by the Timed On Control Does NOT update any changeListeners
-
-
-
Method Detail
-
getControlType
int getControlType()
Get the control type used by the Control- Returns:
- the Control Type, eg. FAST_CLOCK_CONTROL
-
setControlType
void setControlType(int type)
Set the control type used by the Control Does NOT update any changelisteners- Parameters:
type
- the Control Type, eg. FAST_CLOCK_CONTROL
-
setControlSensorName
void setControlSensorName(java.lang.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- Parameters:
sensorName
- the Sensor name
-
getControlSensorSense
int getControlSensorSense()
Get the Sensor State used by the 1 Sensor Control- Returns:
- Sensor.ACTIVE or Sensor.INACTIVE
-
getControlSensorName
java.lang.String getControlSensorName()
Get the Sensor 1 name for 1 and 2 Sensor Control Types.- Returns:
- If a Sensor is registered, returns the Sensor.getName() else the Sensor Name as set by #setControlSensorName
-
setControlSensorSense
void setControlSensorSense(int sense)
Set the Sensor State used by the Control Does NOT update any changelisteners- Parameters:
sense
- The state to react to, eg. Sensor.ACTIVE or Sensor.INACTIVE
-
getFastClockOnHour
int getFastClockOnHour()
Get the Fast Clock On Hour.- Returns:
- On Hour value
-
getFastClockOnMin
int getFastClockOnMin()
Get the Fast Clock On Minute.- Returns:
- On Minute value
-
getFastClockOnCombined
int getFastClockOnCombined()
Get the Fast Clock On Hours and Minutes Combined Convenience method of separate getFastClockOnHour() and getFastClockOnMin()- Returns:
- Total combined Minute value
-
getFastClockOffHour
int getFastClockOffHour()
Get the Fast Clock Off Hour.- Returns:
- Off Hour value
-
getFastClockOffMin
int getFastClockOffMin()
Get the Fast Clock Off Minute.- Returns:
- Off Minute value
-
getFastClockOffCombined
int getFastClockOffCombined()
Get the Fast Clock Off Hours and Minutes Combined Convenience method of separate getFastClockOnHour() and getFastClockOnMin()- Returns:
- Total combined Minute value
-
setFastClockControlSchedule
void setFastClockControlSchedule(int onHour, int onMin, int offHour, int offMin)
Set a Fast Clock LightControl Schedule.- Parameters:
onHour
- Hour the Light should switch OnonMin
- Minute the Light should switch OnoffHour
- Hour the Light should switch OffoffMin
- Minute the Light should switch Off *
-
getControlTurnoutName
java.lang.String getControlTurnoutName()
Get the LightControl Turnout Name.- Returns:
- The Turnout name
-
setControlTurnout
void setControlTurnout(java.lang.String turnoutName)
Set the Turnout used by the Control Does NOT update any changelistenersA Turnout of this name is provided by the TurnoutManager on LightControl Initialisation
- Parameters:
turnoutName
- The Turnout name
-
getControlTurnoutState
int getControlTurnoutState()
Get the LightControl Turnout Name.- Returns:
- The Turnout name
-
setControlTurnoutState
void setControlTurnoutState(int state)
Set the Turnout State used by the Control Does NOT update any changelisteners- Parameters:
state
- Turnout state to act on, eg. Turnout.CLOSED or Turnout.THROWN
-
getTimedSensorName
java.lang.String getTimedSensorName()
Get the Timed On Trigger Sensor name.- Returns:
- The Sensor Name as set by #setControlTimedOnSensorName
-
getControlTimedOnSensorName
java.lang.String getControlTimedOnSensorName()
Get the Timed On Trigger Sensor name.- Returns:
- If a Sensor is registered, returns the Sensor.getName() else the Sensor Name as set by #setControlTimedOnSensorName
-
setControlTimedOnSensorName
void setControlTimedOnSensorName(java.lang.String sensorName)
Set Sensor used by the Timed On Control Does NOT update any changelisteners- Parameters:
sensorName
- the Sensor name to be used for the On Trigger
-
getTimedOnDuration
int getTimedOnDuration()
Get the Timed On Control Duration- Returns:
- duration in ms
-
setTimedOnDuration
void setTimedOnDuration(int duration)
Set Duration used by the Timed On Control Does NOT update any changeListeners- Parameters:
duration
- in ms following the Sensor On Trigger
-
getControlSensor2Name
java.lang.String getControlSensor2Name()
Get the Second Sensor name. as used in the 2 Sensor Control Group.- Returns:
- If a 2nd Sensor is registered, returns the Sensor.getName() else the 2nd Sensor Name as set by #setControlSensor2Name
-
setControlSensor2Name
void setControlSensor2Name(java.lang.String sensorName)
Set Sensor 2 used by the 2 Sensor Control Does NOT update any changelisteners- Parameters:
sensorName
- the Sensor 2 name
-
setParentLight
void setParentLight(Light l)
Set Light to control Does NOT update any changelisteners- Parameters:
l
- the Light object to control
-
getDescriptionText
java.lang.String getDescriptionText(java.lang.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.- Parameters:
lightName
- the Light Name, can be empty.- Returns:
- An I18N full-text description of thiscontrol
-
activateLightControl
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
-
onOffTimesFaulty
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.
- Returns:
- true if the clock on time equals the off time, otherwise false.
-
areFollowerTimesFaulty
boolean areFollowerTimesFaulty(java.util.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.
- Parameters:
compareList
- the ArrayList of other Light Controls to compare against- Returns:
- true if there are multiple exact same times
-
deactivateLightControl
void deactivateLightControl()
Deactivates a LightControl by control type. This method tests the control type, and deactivates the control mechanism, appropriate for the control type.
-
-