Package jmri

Enum SpeedStepMode

java.lang.Object

java.lang.Enum<SpeedStepMode>

jmri.SpeedStepMode

All Implemented Interfaces:

Serializable, Comparable<SpeedStepMode>, java.lang.constant.Constable

@Immutable
public enum SpeedStepMode
extends Enum<SpeedStepMode>

DCC Speed Step Mode. 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/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INCREMENTAL
MOTOROLA_28
NMRA_DCC_128
NMRA_DCC_14
NMRA_DCC_27
NMRA_DCC_28
TMCC1_100
TMCC1_32
TMCC1TR_100
TMCC1TR_32
TMCC2_200
TMCC2_32
TMCC2TR_200
TMCC2TR_32
UNKNOWN

Field Summary

Fields

Modifier and Type	Field	Description
final String	description
final float	increment	The increment between steps, e.g. 1 / 126 for DCC 128
final String	name
final int	numSteps	The Number of steps, e.g. 126 for DCC 128

Method Summary

Modifier and Type	Method	Description
static SpeedStepMode	bestCompatibleMode(EnumSet<SpeedStepMode> command_station_modes, EnumSet<SpeedStepMode> decoder_modes)
static SpeedStepMode	bestMode(EnumSet<SpeedStepMode> modes)
static SpeedStepMode	getByDescription(String name)	Convert a localized name string to a DCC speed step mode.
static SpeedStepMode	getByName(String name)	Convert a human-readable string to a DCC speed step mode.
static EnumSet<SpeedStepMode>	getCompatibleModes(EnumSet<SpeedStepMode> command_station_modes, EnumSet<SpeedStepMode> decoder_modes)
static EnumSet<SpeedStepMode>	getCompatibleModesForProtocol(LocoAddress.Protocol protocol)
String	toString()	Get a locale friendly Step Mode Description.
static SpeedStepMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SpeedStepMode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNKNOWN

public static final SpeedStepMode UNKNOWN

NMRA_DCC_128

public static final SpeedStepMode NMRA_DCC_128

NMRA_DCC_28

public static final SpeedStepMode NMRA_DCC_28

NMRA_DCC_27

public static final SpeedStepMode NMRA_DCC_27

NMRA_DCC_14

public static final SpeedStepMode NMRA_DCC_14

MOTOROLA_28

public static final SpeedStepMode MOTOROLA_28

TMCC1_32

public static final SpeedStepMode TMCC1_32

TMCC2_32

public static final SpeedStepMode TMCC2_32

TMCC1_100

public static final SpeedStepMode TMCC1_100

TMCC2_200

public static final SpeedStepMode TMCC2_200

TMCC1TR_32

public static final SpeedStepMode TMCC1TR_32

TMCC2TR_32

public static final SpeedStepMode TMCC2TR_32

TMCC1TR_100

public static final SpeedStepMode TMCC1TR_100

TMCC2TR_200

public static final SpeedStepMode TMCC2TR_200

INCREMENTAL

public static final SpeedStepMode INCREMENTAL

Field Details

name

public final String name

numSteps

public final int numSteps

The Number of steps, e.g. 126 for DCC 128

increment

public final float increment

The increment between steps, e.g. 1 / 126 for DCC 128

description

public final String description

Method Details

values

public static SpeedStepMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SpeedStepMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Get a locale friendly Step Mode Description. For just "128" use name()

Overrides:

toString in class Enum<SpeedStepMode>

Returns:

e.g. "128 SS"

getByName

public static SpeedStepMode getByName(String name)

Convert a human-readable string to a DCC speed step mode.

Parameters:

name - string version of speed step mode; example "128"

Returns:

matching SpeedStepMode

Throws:

IllegalArgumentException - if name does not correspond to a valid speed step mode.

getByDescription

public static SpeedStepMode getByDescription(String name)

Convert a localized name string to a DCC speed step mode.

Parameters:

name - localized string version of speed step mode; example "128"

Returns:

matching SpeedStepMode

Throws:

IllegalArgumentException - if name does not correspond to a valid speed step mode.

getCompatibleModes

public static EnumSet<SpeedStepMode> getCompatibleModes(EnumSet<SpeedStepMode> command_station_modes,
 EnumSet<SpeedStepMode> decoder_modes)

bestCompatibleMode

public static SpeedStepMode bestCompatibleMode(EnumSet<SpeedStepMode> command_station_modes,
 EnumSet<SpeedStepMode> decoder_modes)

bestMode

public static SpeedStepMode bestMode(EnumSet<SpeedStepMode> modes)

getCompatibleModesForProtocol

public static EnumSet<SpeedStepMode> getCompatibleModesForProtocol(LocoAddress.Protocol protocol)