SteamSound (JMRI API)

java.lang.Object
- jmri.jmrit.vsdecoder.VSDSound
- - jmri.jmrit.vsdecoder.EngineSound
  - - jmri.jmrit.vsdecoder.SteamSound

```
class SteamSound
extends EngineSound
```
Steam Sound initial version.
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.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

(package private) class SteamSound.RPMSound

Field Summary

Fields
Modifier and Type Field Description

(package private) int top_speed
- Fields inherited from class jmri.jmrit.vsdecoder.EngineSound
  auto_start_engine, engine_gain, engine_pane, engine_rd, exponent, fade_in_time, fade_length, fade_out_time, is_auto_start, sleep_interval
- Fields inherited from class jmri.jmrit.vsdecoder.VSDSound
  BufSysNamePrefix, BufUserNamePrefix, default_exponent, default_gain, default_reference_distance, default_sleep_interval, gain, is_tunnel, myposition, name, SrcSysNamePrefix, SrcUserNamePrefix, t, tunnel_volume, volume

Constructor Summary

Constructors
Constructor Description

SteamSound(java.lang.String name)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`changeThrottle(float t)`
`org.jdom2.Element`	`getXml()`
`void`	`mute(boolean m)`
`void`	`setPosition(PhysicalLocation p)`
`void`	`setVolume(float v)`
`void`	`setXml(org.jdom2.Element e, VSDFile vf)`
`void`	`shutdown()`
`void`	`startEngine()`
`void`	`stopEngine()`

Methods inherited from class jmri.jmrit.vsdecoder.EngineSound
autoStartCheck, calcEngineNotch, calcEngineNotch, changeLocoDirection, fadeIn, fadeOut, functionKey, getActualSpeed, getBuffersFreeState, getFadeInTime, getFadeOutTime, getFirstSpeed, handleSpeedChange, isEngineStarted, loop, play, setActualSpeed, setBuffersFreeState, setEngineStarted, setFadeInTime, setFadeInTime, setFadeOutTime, setFadeOutTime, setFirstSpeed, setXMLAutoStart, setXMLEngineReferenceDistance, setXMLExponent, setXMLGain, setXMLReferenceDistance, setXMLSleepInterval, speedCurve, stop

Methods inherited from class jmri.jmrit.vsdecoder.VSDSound
attachSourcesToEffects, changeNotch, checkForFreeBuffer, detachSourcesToEffects, getGain, getName, getPosition, getTunnel, newTimer, setGain, setName, setTunnel, setXml

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

- Field Detail
  - top_speed
```
int top_speed
```
- Constructor Detail
  - SteamSound
```
public SteamSound(java.lang.String name)
```
- Method Detail
  - startEngine
```
public void startEngine()
```
    Overrides:
    
    startEngine in class EngineSound
  - stopEngine
```
public void stopEngine()
```
    Overrides:
    
    stopEngine in class EngineSound
  - changeThrottle
```
public void changeThrottle(float t)
```
    Overrides:
    
    changeThrottle in class VSDSound
  - shutdown
```
public void shutdown()
```
    Overrides:
    
    shutdown in class EngineSound
  - mute
```
public void mute(boolean m)
```
    Overrides:
    
    mute in class EngineSound
  - setVolume
```
public void setVolume(float v)
```
    Overrides:
    
    setVolume in class EngineSound
  - setPosition
```
public void setPosition(PhysicalLocation p)
```
    Overrides:
    
    setPosition in class VSDSound
  - getXml
```
public org.jdom2.Element getXml()
```
    Overrides:
    
    getXml in class EngineSound
  - setXml
```
public void setXml(org.jdom2.Element e,
                   VSDFile vf)
```
    Overrides:
    
    setXml in class EngineSound