All Implemented Interfaces:: kotlin.Comparable


public class ModbusValue<VALUE extends ModbusValue<VALUE, TYPE>, TYPE extends Object>
 implements Comparable<VALUE>

Holds the single value of a single modbus coil/discrete input or register

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private String`	`fetchGroup`
`private Boolean`	`immutable`
`private final TYPE`	`value`
`private String`	`comment`
`private final Long`	`timestamp`
`private Boolean`	`hardReadError`
`private final String`	`asString`
`private final Address`	`address`

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getFetchGroup()`	An identifier to that can be used to ensure some registers are retrieved together.
`final Unit`	`setFetchGroup(String fetchGroup)`	An identifier to that can be used to ensure some registers are retrieved together.
`final Boolean`	`getImmutable()`	Some registers will NEVER change and thus do not need to be retrieved a second time
`final Unit`	`setImmutable(Boolean immutable)`	Some registers will NEVER change and thus do not need to be retrieved a second time
`final TYPE`	`getValue()`
`final String`	`getComment()`	If a value has a comment this can be used when converting it to a String (in yaml for example)
`final Unit`	`setComment(String comment)`	If a value has a comment this can be used when converting it to a String (in yaml for example)
`final Long`	`getTimestamp()`
`final Boolean`	`getHardReadError()`
`final Unit`	`setHardReadError(Boolean hardReadError)`
`final String`	`getAsString()`
`final Address`	`getAddress()`	The modbus coil/discrete/register input address.
`final VALUE`	`clone()`
`final VALUE`	`setValue(TYPE value)`
`final VALUE`	`setValue(VALUE modbusValue)`
`final VALUE`	`setValue(TYPE value, Long timestamp)`
`final Boolean`	`hasValue()`
`final Unit`	`setSoftReadError()`
`final Unit`	`setHardReadError()`
`final Boolean`	`isReadError()`
`final Unit`	`clearSoftReadError()`
`final Boolean`	`needsToBeUpdated(Long now, Long maxAge)`
`final Unit`	`clear()`
`abstract String`	`toSingleValueString()`
`Integer`	`compareTo(VALUE other)`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`

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

- Constructor Detail
- Method Detail
  - getFetchGroup
```
 final String getFetchGroup()
```
    An identifier to that can be used to ensure some registers are retrieved together. By default, filled with a random unique value because we assume they are all independent.
  - setFetchGroup
```
 final Unit setFetchGroup(String fetchGroup)
```
    An identifier to that can be used to ensure some registers are retrieved together. By default, filled with a random unique value because we assume they are all independent.
  - getImmutable
```
 final Boolean getImmutable()
```
    Some registers will NEVER change and thus do not need to be retrieved a second time
  - setImmutable
```
 final Unit setImmutable(Boolean immutable)
```
    Some registers will NEVER change and thus do not need to be retrieved a second time
  - getValue
```
 final TYPE getValue()
```
  - getComment
```
 final String getComment()
```
    If a value has a comment this can be used when converting it to a String (in yaml for example)
  - setComment
```
 final Unit setComment(String comment)
```
    If a value has a comment this can be used when converting it to a String (in yaml for example)
  - getTimestamp
```
 final Long getTimestamp()
```
  - getHardReadError
```
 final Boolean getHardReadError()
```
  - setHardReadError
```
 final Unit setHardReadError(Boolean hardReadError)
```
  - getAsString
```
 final String getAsString()
```
  - getAddress
```
 final Address getAddress()
```
    The modbus coil/discrete/register input address.
  - clone
```
 final VALUE clone()
```
  - setValue
```
 final VALUE setValue(TYPE value)
```
  - setValue
```
 final VALUE setValue(VALUE modbusValue)
```
  - setValue
```
 final VALUE setValue(TYPE value, Long timestamp)
```
  - hasValue
```
 final Boolean hasValue()
```
  - setSoftReadError
```
 final Unit setSoftReadError()
```
  - setHardReadError
```
 final Unit setHardReadError()
```
  - isReadError
```
 final Boolean isReadError()
```
  - clearSoftReadError
```
 final Unit clearSoftReadError()
```
  - needsToBeUpdated
```
 final Boolean needsToBeUpdated(Long now, Long maxAge)
```
  - clear
```
 final Unit clear()
```
  - toSingleValueString
```
 abstract String toSingleValueString()
```
  - compareTo
```
 Integer compareTo(VALUE other)
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```

Class ModbusValue

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

getFetchGroup

setFetchGroup

getImmutable

setImmutable

getValue

getComment

setComment

getTimestamp

getHardReadError

setHardReadError

getAsString

getAddress

clone

setValue

setValue

setValue

hasValue

setSoftReadError

setHardReadError

isReadError

clearSoftReadError

needsToBeUpdated

clear

toSingleValueString

compareTo

equals

hashCode