Enum AddressClass
-
- All Implemented Interfaces:
-
java.io.Serializable,kotlin.Comparable
public enum AddressClass extends Enum<AddressClass>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enumAddressClass.Typepublic classAddressClass.Companion
-
Field Summary
Fields Modifier and Type Field Description private final List<String>labelsprivate final IntegerbaseOffsetprivate final IntegerbitsPerValueprivate final AddressClass.Typetypeprivate final IntegerregisterNumberOffsetprivate final StringreadableIdprivate final StringenumNameprivate final StringshortLabelprivate final StringlongLabelprivate final Stringnameprivate final Integerordinalprivate final EnumEntries<AddressClass>entries
-
Enum Constant Summary
Enum Constants Enum Constant Description COILA Coil is a read/write single bit value
DISCRETE_INPUTA Discrete Input is a readonly single bit value
INPUT_REGISTERAn Input Register is a readonly 16 bit register
HOLDING_REGISTERA Holding Register is a read/write 16 bit register
-
Method Summary
Modifier and Type Method Description final AddressClassvalueOf(String value)Returns the enum constant of this type with the specified name. final Array<AddressClass>values()Returns an array containing the constants of this enum type, in the order they're declared. final List<String>getLabels()final IntegergetBaseOffset()The "offset" used in the modicon notation. final IntegergetBitsPerValue()Sometimes 1 bit per value (booleans really), sometimes 16 bits (registers) final AddressClass.TypegetType()An enum value making the distinction between 1 bit per value (booleans) and 16 bits (registers) final IntegergetRegisterNumberOffset()Offset from the "Physical Modbus Address" to the "Register Number" final StringgetReadableId()A human-readable name final StringgetEnumName()The java code name of this enum which can be used for code generation final StringgetShortLabel()The additional labels on which the instance must also be returned. final StringgetLongLabel()final EnumEntries<AddressClass>getEntries()-
-
Method Detail
-
valueOf
final AddressClass valueOf(String value)
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.)
-
values
final Array<AddressClass> values()
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
-
getBaseOffset
final Integer getBaseOffset()
The "offset" used in the modicon notation. (I.e. the address is shifted by this much (* 10000, or * 100000) when specified).
-
getBitsPerValue
final Integer getBitsPerValue()
Sometimes 1 bit per value (booleans really), sometimes 16 bits (registers)
-
getType
final AddressClass.Type getType()
An enum value making the distinction between 1 bit per value (booleans) and 16 bits (registers)
-
getRegisterNumberOffset
final Integer getRegisterNumberOffset()
Offset from the "Physical Modbus Address" to the "Register Number"
-
getReadableId
final String getReadableId()
A human-readable name
-
getEnumName
final String getEnumName()
The java code name of this enum which can be used for code generation
-
getShortLabel
final String getShortLabel()
The additional labels on which the instance must also be returned.
-
getLongLabel
final String getLongLabel()
-
getEntries
final EnumEntries<AddressClass> getEntries()
-
-
-
-