All Implemented Interfaces:: kotlin.Comparable


public final class RegisterValue
 implements Comparable<RegisterValue>

Holds the single value of a single modbus 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 Short`	`value`
`private String`	`comment`
`private Long`	`fetchTimestamp`
`private final Long`	`timestamp`
`private final Long`	`EPOCH_1900`
`private final Long`	`EPOCH_1888`
`private final Long`	`NEVER_VALID_BEFORE`
`private final Long`	`READERROR_TIMESTAMP`
`private Boolean`	`hardReadError`
`private final String`	`hexValue`
`private final Address`	`address`

Constructor Summary

Constructors
Constructor	Description
`RegisterValue(Address address)`

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 Short`	`getValue()`
`final String`	`getComment()`	If a register has a comment this can be used when converting it to a String (in yaml for example)
`final Unit`	`setComment(String comment)`	If a register has a comment this can be used when converting it to a String (in yaml for example)
`final Long`	`getFetchTimestamp()`
`final Unit`	`setFetchTimestamp(Long fetchTimestamp)`
`final Long`	`getTimestamp()`
`final Long`	`getEPOCH_1900()`	1900-01-01T00:00:00.
`final Long`	`getEPOCH_1888()`	1888-08-08T08:08:08.
`final Long`	`getNEVER_VALID_BEFORE()`
`final Long`	`getREADERROR_TIMESTAMP()`
`final Boolean`	`getHardReadError()`
`final Unit`	`setHardReadError(Boolean hardReadError)`
`final String`	`getHexValue()`
`final Address`	`getAddress()`	The modbus register address.
`final RegisterValue`	`clone()`
`final RegisterValue`	`setValue(Short value)`
`final RegisterValue`	`setValue(RegisterValue registerValue)`
`final RegisterValue`	`setValue(Short 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()`
`String`	`toString()`
`Integer`	`compareTo(RegisterValue 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
  - RegisterValue
```
RegisterValue(Address address)
```
- 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 Short getValue()
```
  - getComment
```
 final String getComment()
```
    If a register 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 register has a comment this can be used when converting it to a String (in yaml for example)
  - getFetchTimestamp
```
 final Long getFetchTimestamp()
```
  - setFetchTimestamp
```
 final Unit setFetchTimestamp(Long fetchTimestamp)
```
  - getTimestamp
```
 final Long getTimestamp()
```
  - getEPOCH_1900
```
 final Long getEPOCH_1900()
```
    1900-01-01T00:00:00.000Z
  - getEPOCH_1888
```
 final Long getEPOCH_1888()
```
    1888-08-08T08:08:08.888Z
  - getNEVER_VALID_BEFORE
```
 final Long getNEVER_VALID_BEFORE()
```
  - getREADERROR_TIMESTAMP
```
 final Long getREADERROR_TIMESTAMP()
```
  - getHardReadError
```
 final Boolean getHardReadError()
```
  - setHardReadError
```
 final Unit setHardReadError(Boolean hardReadError)
```
  - getHexValue
```
 final String getHexValue()
```
    Returns:
    
    The current register value as a 4 digit HEX string in uppercase. Or "----" in case of null.
  - getAddress
```
 final Address getAddress()
```
    The modbus register address.
  - clone
```
 final RegisterValue clone()
```
  - setValue
```
 final RegisterValue setValue(Short value)
```
  - setValue
```
 final RegisterValue setValue(RegisterValue registerValue)
```
  - setValue
```
 final RegisterValue setValue(Short 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()
```
  - toString
```
 String toString()
```
  - compareTo
```
 Integer compareTo(RegisterValue other)
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```

Class RegisterValue

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RegisterValue

Method Detail

getFetchGroup

setFetchGroup

getImmutable

setImmutable

getValue

getComment

setComment

getFetchTimestamp

setFetchTimestamp

getTimestamp

getEPOCH_1900

getEPOCH_1888

getNEVER_VALID_BEFORE

getREADERROR_TIMESTAMP

getHardReadError

setHardReadError

getHexValue

getAddress

clone

setValue

setValue

setValue

hasValue

setSoftReadError

setHardReadError

isReadError

clearSoftReadError

needsToBeUpdated

clear

toString

compareTo

equals

hashCode