All Implemented Interfaces:

kotlin.Comparable
```
public final class Address
 implements Comparable<Address>
                    
```
The ModBus Address of a single register. An Address instance is IMMUTABLE !!

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final Integer`	`registerNumber`
`private final AddressClass`	`addressClass`
`private final Integer`	`physicalAddress`

Constructor Summary

Constructors
Constructor	Description
`Address(AddressClass addressClass, Integer physicalAddress)`	Creates a new immutable Modbus Address instance.

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Integer`	`getRegisterNumber()`
`final AddressClass`	`getAddressClass()`	The kind of the address (which limits the allowed function codes)
`final Integer`	`getPhysicalAddress()`	The technical wire address.
`final Address`	`increment(Integer step)`	Increment the address by `step`
`final Address`	`increment()`	Increment the address by `step`
`final Integer`	`distance(Address address)`
`String`	`toString()`
`final String`	`toCleanFormat()`
`final String`	`toModicon5()`
`final String`	`toModicon6()`
`final String`	`toModiconX()`
`Integer`	`compareTo(Address other)`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`final static Address`	`of(AddressClass addressClass, Integer physicalAddress)`	Creates a new Modbus Address instance.
`final static Address`	`of(String registerTag)`	Create the address by parsing the provided register format.
`final static Address`	`ofModicon5(Integer modicon5RegisterTag)`	Create the address by parsing the provided numerical register format.
`final static Address`	`ofModicon6(Integer modicon6RegisterTag)`	Create the address by parsing the provided numerical register format.

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

- Constructor Detail
  - Address
```
Address(AddressClass addressClass, Integer physicalAddress)
```
    Creates a new immutable Modbus Address instance.
- Method Detail
  - getRegisterNumber
```
 final Integer getRegisterNumber()
```
  - getAddressClass
```
 final AddressClass getAddressClass()
```
    The kind of the address (which limits the allowed function codes)
  - getPhysicalAddress
```
 final Integer getPhysicalAddress()
```
    The technical wire address. Always in the 0-65535 range.
  - increment
```
@JvmOverloads() final Address increment(Integer step)
```
    Increment the address by step
    
    Parameters:
    
    step - The desired address increase (step=1 if unspecified).
    
    Returns:
    
    A NEW (incremented) immutable instance
  - increment
```
@JvmOverloads() final Address increment()
```
    Increment the address by step
    
    Returns:
    
    A NEW (incremented) immutable instance
  - distance
```
 final Integer distance(Address address)
```
    Parameters:
    
    address - The address to compare to
    
    Returns:
    
    The "Increment" difference to get from this Address to the provided Address. Returns null if not the same address class
  - toString
```
 String toString()
```
    Returns:
    
    The stored address as cleanly parsable format without the "off by one" problem. For example "hr:00123".
  - toCleanFormat
```
 final String toCleanFormat()
```
    Returns:
    
    The stored address as cleanly parsable format without the "off by one" problem. For example "hr:00123".
  - toModicon5
```
 final String toModicon5()
```
    Returns:
    
    The stored address as an original modicon 5 digit value (or null if the register number is 9999). For example "40124".
  - toModicon6
```
 final String toModicon6()
```
    Returns:
    
    The stored address as a modicon 6 digit value. For example "400124".
  - toModiconX
```
 final String toModiconX()
```
    Returns:
    
    The stored address as a modicon variant with an 'x' separator. For example "4x00124".
  - compareTo
```
 Integer compareTo(Address other)
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - of
```
 final static Address of(AddressClass addressClass, Integer physicalAddress)
```
    Creates a new Modbus Address instance.
    
    Returns:
    
    A new immutable instance of Address with the given values
  - of
```
 final static Address of(String registerTag)
```
    Create the address by parsing the provided register format.
    
    Parameters:
    
    registerTag - The register's tag in one of the supported formats (for example: "40124", "400124", "4x124", "4x000124", "hr:123").
    
    Returns:
    
    A new immutable instance of Address with the given values
  - ofModicon5
```
 final static Address ofModicon5(Integer modicon5RegisterTag)
```
    Create the address by parsing the provided numerical register format. This ONLY allows the original Modicon 5 digit format.
    
    Parameters:
    
    modicon5RegisterTag - The register's tag in the original Modicon 5 digit format.
    
    Returns:
    
    A new immutable instance of Address with the given values
  - ofModicon6
```
 final static Address ofModicon6(Integer modicon6RegisterTag)
```
    Create the address by parsing the provided numerical register format. This ONLY allows the Modicon 6 digit format.
    
    Parameters:
    
    modicon6RegisterTag - The register's tag in the Modicon 6 digit format.
    
    Returns:
    
    a new immutable instance of Address with the given values

Class Address

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Address

Method Detail

getRegisterNumber

getAddressClass

getPhysicalAddress

increment

increment

distance

toString

toCleanFormat

toModicon5

toModicon6

toModiconX

compareTo

equals

hashCode

of

of

ofModicon5

ofModicon6