Package jmri.jmrit.vsdecoder

Class EngineSound

java.lang.Object

jmri.jmrit.vsdecoder.VSDSound

jmri.jmrit.vsdecoder.EngineSound

Direct Known Subclasses:

Diesel3Sound, DieselSound, Steam1Sound, SteamSound

public class EngineSound
extends VSDSound

Superclass for Steam, Diesel and Electric Sound. 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.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) boolean	auto_start_engine
(package private) float	engine_gain
(package private) EnginePane	engine_pane
(package private) float	engine_rd
(package private) float	exponent
(package private) int	fade_in_time
(package private) int	fade_length
(package private) int	fade_out_time
(package private) boolean	is_auto_start
(package private) int	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
EngineSound(String name)

Method Summary

Modifier and Type	Method	Description
(package private) void	autoStartCheck()
static final int	calcEngineNotch(double throttle)
static final int	calcEngineNotch(float throttle)
void	changeLocoDirection(int d)
void	fadeIn()
void	fadeOut()
void	functionKey(String e, boolean v, String n)
float	getActualSpeed()
(package private) boolean	getBuffersFreeState()
int	getFadeInTime()
int	getFadeOutTime()
(package private) boolean	getFirstSpeed()
org.jdom2.Element	getXml()
void	handleSpeedChange(Float s, EnginePane e)
boolean	isEngineStarted()
void	loop()
void	mute(boolean m)
void	play()
(package private) void	setActualSpeed(float a)
(package private) void	setBuffersFreeState(boolean state)
void	setEngineStarted(boolean es)
protected void	setFadeInTime(int t)
protected void	setFadeInTime(String s)
protected void	setFadeOutTime(int t)
protected void	setFadeOutTime(String s)
(package private) void	setFirstSpeed(boolean f)
void	setVolume(float v)
void	setXml(org.jdom2.Element e, VSDFile vf)
protected boolean	setXMLAutoStart(org.jdom2.Element e)
protected float	setXMLEngineReferenceDistance(org.jdom2.Element e)
protected float	setXMLExponent(org.jdom2.Element e)
protected float	setXMLGain(org.jdom2.Element e)
protected float	setXMLReferenceDistance(org.jdom2.Element e)
protected int	setXMLSleepInterval(org.jdom2.Element e)
void	shutdown()
(package private) double	speedCurve(float t)
void	startEngine()
void	stop()
void	stopEngine()

Methods inherited from class jmri.jmrit.vsdecoder.VSDSound

attachSourcesToEffects, changeNotch, changeThrottle, checkForFreeBuffer, detachSourcesToEffects, getGain, getName, getPosition, getTunnel, newTimer, setGain, setName, setPosition, setTunnel, setXml

Methods inherited from class java.lang.Object

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

Field Details

auto_start_engine

boolean auto_start_engine

is_auto_start

boolean is_auto_start

fade_length

int fade_length

fade_in_time

int fade_in_time

fade_out_time

int fade_out_time

engine_rd

float engine_rd

engine_gain

float engine_gain

sleep_interval

int sleep_interval

exponent

float exponent

engine_pane

EnginePane engine_pane

Constructor Details

EngineSound

public EngineSound(String name)

Method Details

play

public void play()

Specified by:

play in class VSDSound

loop

public void loop()

Specified by:

loop in class VSDSound

stop

public void stop()

Specified by:

stop in class VSDSound

fadeIn

public void fadeIn()

Specified by:

fadeIn in class VSDSound

fadeOut

public void fadeOut()

Specified by:

fadeOut in class VSDSound

getFadeInTime

public int getFadeInTime()

getFadeOutTime

public int getFadeOutTime()

setFadeInTime

protected void setFadeInTime(int t)

setFadeInTime

protected void setFadeInTime(String s)

setFadeOutTime

protected void setFadeOutTime(int t)

setFadeOutTime

protected void setFadeOutTime(String s)

calcEngineNotch

public static final int calcEngineNotch(float throttle)

calcEngineNotch

public static final int calcEngineNotch(double throttle)

handleSpeedChange

public void handleSpeedChange(Float s,
 EnginePane e)

setFirstSpeed

void setFirstSpeed(boolean f)

getFirstSpeed

boolean getFirstSpeed()

setActualSpeed

void setActualSpeed(float a)

getActualSpeed

public float getActualSpeed()

speedCurve

double speedCurve(float t)

startEngine

public void startEngine()

stopEngine

public void stopEngine()

isEngineStarted

public boolean isEngineStarted()

setEngineStarted

public void setEngineStarted(boolean es)

functionKey

public void functionKey(String e,
 boolean v,
 String n)

changeLocoDirection

public void changeLocoDirection(int d)

shutdown

public void shutdown()

Specified by:

shutdown in class VSDSound

mute

public void mute(boolean m)

Specified by:

mute in class VSDSound

setVolume

public void setVolume(float v)

Specified by:

setVolume in class VSDSound

getBuffersFreeState

boolean getBuffersFreeState()

setBuffersFreeState

void setBuffersFreeState(boolean state)

autoStartCheck

void autoStartCheck()

setXMLAutoStart

protected boolean setXMLAutoStart(org.jdom2.Element e)

setXMLExponent

protected float setXMLExponent(org.jdom2.Element e)

setXMLGain

protected float setXMLGain(org.jdom2.Element e)

setXMLReferenceDistance

protected float setXMLReferenceDistance(org.jdom2.Element e)

setXMLEngineReferenceDistance

protected float setXMLEngineReferenceDistance(org.jdom2.Element e)

setXMLSleepInterval

protected int setXMLSleepInterval(org.jdom2.Element e)

getXml

public org.jdom2.Element getXml()

Overrides:

getXml in class VSDSound

setXml

public void setXml(org.jdom2.Element e,
 VSDFile vf)