Enum Class Rack
- All Implemented Interfaces:
Serializable
,Comparable<Rack>
,Constable
Helper enum to wrap information about racks.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants -
Field Summary
FieldsModifier and TypeFieldDescriptionfinal int
final int
final ClusterVersionBChannelId
final SoltaroCluster.ChannelId
final SoltaroCluster.ChannelId
-
Method Summary
Modifier and TypeMethodDescriptionGets the Channel-Doc Text Prefix for this Rack in the form "Rack X ".Gets the Channel-ID Prefix for this Rack in the form "RACK_X_".static Rack
getRack
(int rackId) Get theRack
for the given ID.static Rack
Returns the enum constant of this class with the specified name.static Rack[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
RACK_1
-
RACK_2
-
RACK_3
-
RACK_4
-
RACK_5
-
-
Field Details
-
id
public final int id -
offset
public final int offset -
usageChannelId
-
positiveContactorChannelId
-
subMasterCommunicationAlarmChannelId
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-
getRack
Get theRack
for the given ID.- Parameters:
rackId
- from 1 to 5- Returns:
- the
Rack
-
getChannelIdPrefix
Gets the Channel-ID Prefix for this Rack in the form "RACK_X_".- Returns:
- the prefix
-
getChannelDocTextPrefix
Gets the Channel-Doc Text Prefix for this Rack in the form "Rack X ".- Returns:
- the prefix
-