VirtualSignalHead (JMRI API)

java.lang.Object
- jmri.implementation.AbstractNamedBean
- - jmri.implementation.AbstractSignalHead
  - - jmri.implementation.DefaultSignalHead
    - - jmri.implementation.VirtualSignalHead

All Implemented Interfaces:

java.beans.VetoableChangeListener, java.lang.Comparable<NamedBean>, java.util.EventListener, PropertyChangeProvider, NamedBean, Signal, SignalHead
```
public class VirtualSignalHead
extends DefaultSignalHead
```
A signal head that exists only within the program.
This can be useful e.g. as part of a more complex signal calculation.

Nested Class Summary
- Nested classes/interfaces inherited from interface jmri.NamedBean
  NamedBean.BadNameException, NamedBean.BadSystemNameException, NamedBean.BadUserNameException, NamedBean.DisplayOptions, NamedBean.DuplicateSystemNameException

Field Summary
- Fields inherited from class jmri.implementation.DefaultSignalHead
  delay, masterDelay, mFlashOn, timer
- Fields inherited from class jmri.implementation.AbstractSignalHead
  mAppearance, mHeld, mLit
- Fields inherited from class jmri.implementation.AbstractNamedBean
  listenerRefs, mSystemName, register
- Fields inherited from interface jmri.NamedBean
  DISPLAY_NAME_FORMAT, INCONSISTENT, PROPERTY_STATE, QUOTED_NAME_FORMAT, UNKNOWN
- Fields inherited from interface jmri.SignalHead
  DARK, FLASHGREEN, FLASHLUNAR, FLASHRED, FLASHYELLOW, GREEN, HELD, LUNAR, RED, YELLOW

Constructor Summary

Constructors
Constructor Description

VirtualSignalHead(java.lang.String sys)

VirtualSignalHead(java.lang.String sys, java.lang.String user)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`isTurnoutUsed(Turnout t)`	Check if a given turnout is used on this head.
`protected void`	`updateOutput()`	Type-specific routine to handle output to the layout hardware.

Methods inherited from class jmri.implementation.DefaultSignalHead
appearanceSetsFlashTimer, getUsageReport, getValidStateKeys, getValidStateNames, getValidStates, setAppearance, setHeld, setLit, startFlash, stopFlash

Methods inherited from class jmri.implementation.AbstractSignalHead
getAppearance, getAppearanceKey, getAppearanceKey, getAppearanceName, getAppearanceName, getBeanType, getDefaultStateName, getDefaultValidStateNames, getDefaultValidStates, getHeld, getLit, getState, isAtStop, isCleared, isShowingRestricting, setState, vetoableChange

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jmri.beans.PropertyChangeProvider
addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

- Constructor Detail
  - VirtualSignalHead
```
public VirtualSignalHead(java.lang.String sys,
                         java.lang.String user)
```
  - VirtualSignalHead
```
public VirtualSignalHead(java.lang.String sys)
```
- Method Detail
  - updateOutput
```
protected void updateOutput()
```
    Description copied from class: DefaultSignalHead
    Type-specific routine to handle output to the layout hardware.
    Does not notify listeners of changes; that's done elsewhere. Should use the following variables to determine what to send:
    
    mAppearance
    mLit
    mFlashOn
    Specified by:
    
    updateOutput in class DefaultSignalHead
  - isTurnoutUsed
```
public boolean isTurnoutUsed(Turnout t)
```
    Description copied from class: AbstractSignalHead
    
    Check if a given turnout is used on this head.
    
    Overrides:
    
    isTurnoutUsed in class DefaultSignalHead
    
    Parameters:
    
    t - Turnout object to check
    
    Returns:
    
    true if turnout is configured as output or driver of head