Package jmri.jmrit.ussctc

Class OsIndicator

java.lang.Object

jmri.jmrit.ussctc.OsIndicator

All Implemented Interfaces:

Constants

public class OsIndicator
extends 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) String	lock
(package private) static String	logixPrefix
(package private) static final String	namePrefix
(package private) String	osSensor
(package private) String	output

Fields inherited from interface jmri.jmrit.ussctc.Constants

commonNamePrefix, commonNameSuffix, nameDivider, pkgPrefix

Constructor Summary

Constructors

Constructor	Description
OsIndicator(String outputName)	Create an object to represent an existing OsIndicator.
OsIndicator(String output, String osSensor, String lock)	Create one from scratch

Method Summary

Modifier and Type	Method	Description
String	getLockName()
String	getOsSensorName()
String	getOutputName()
void	instantiate()	Create the underlying objects that implement this

Methods inherited from class java.lang.Object

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

Field Details

logixPrefix

static String logixPrefix

namePrefix

static final String namePrefix

output

String output

osSensor

String osSensor

lock

String lock

Constructor Details

OsIndicator

public OsIndicator(String output,
 String osSensor,
 String lock)

Create one from scratch

Parameters:

output - User- or System name of output turnout to be driven

osSensor - User- or System name of Sensor determining OS occupancy

lock - Name of NamedBean used for Locking (type to be decided)

OsIndicator

public OsIndicator(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 Details

instantiate

public void instantiate()

Create the underlying objects that implement this

getOutputName

public String getOutputName()

getOsSensorName

public String getOsSensorName()

getLockName

public String getLockName()