Package jmri.jmrit.ussctc
Class OsIndicator
- java.lang.Object
-
- jmri.jmrit.ussctc.OsIndicator
-
- All Implemented Interfaces:
Constants
public class OsIndicator extends java.lang.Object implements Constants
Provide bean-like access to the collection of Logix, Routes, Memories, etc that make up a OsIndicator.An OS Indicator drives the lamp on the panel for a particular OS. Honors a separate lock/unlocked indication by showing occupied if the associated turnout has been unlocked.
- See Also:
OsIndicatorFrame
,OsIndicatorPanel
,OsIndicatorAction
-
-
Field Summary
Fields Modifier and Type Field Description (package private) java.lang.String
lock
(package private) static java.lang.String
logixPrefix
(package private) static java.lang.String
namePrefix
(package private) java.lang.String
osSensor
(package private) java.lang.String
output
-
Fields inherited from interface jmri.jmrit.ussctc.Constants
commonNamePrefix, commonNameSuffix, nameDivider, pkgPrefix
-
-
Constructor Summary
Constructors Constructor Description OsIndicator(java.lang.String outputName)
Create an object to represent an existing OsIndicator.OsIndicator(java.lang.String output, java.lang.String osSensor, java.lang.String lock)
Create one from scratch
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getLockName()
java.lang.String
getOsSensorName()
java.lang.String
getOutputName()
void
instantiate()
Create the underlying objects that implement this
-
-
-
Field Detail
-
logixPrefix
static java.lang.String logixPrefix
-
namePrefix
static final java.lang.String namePrefix
-
output
java.lang.String output
-
osSensor
java.lang.String osSensor
-
lock
java.lang.String lock
-
-
Constructor Detail
-
OsIndicator
public OsIndicator(java.lang.String output, java.lang.String osSensor, java.lang.String lock)
Create one from scratch- Parameters:
output
- User- or System name of output turnout to be drivenosSensor
- User- or System name of Sensor determining OS occupancylock
- Name of NamedBean used for Locking (type to be decided)
-
OsIndicator
public OsIndicator(java.lang.String outputName) throws JmriException
Create an object to represent an existing OsIndicator.- Parameters:
outputName
- name of output Turnout that drives the indicator- Throws:
JmriException
- if no such OsIndicator exists, or some problem found
-
-
Method Detail
-
instantiate
public void instantiate()
Create the underlying objects that implement this
-
getOutputName
public java.lang.String getOutputName()
-
getOsSensorName
public java.lang.String getOsSensorName()
-
getLockName
public java.lang.String getLockName()
-
-