Package nl.basjes.modbus.schema

Class Field.FieldBuilder

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      final <Error class: unknown class> block(Block block) The block to which this block must be linked
      final <Error class: unknown class> id(String id) The technical id of this field.
      final <Error class: unknown class> description(String description) A human-readable description of this field.
      final <Error class: unknown class> shortDescription(String shortDescription) A shorter variant of the Human-readable description of the field.
      final <Error class: unknown class> immutable(Boolean immutable) If a field NEVER changes then this can be se to true.
      final <Error class: unknown class> system(Boolean system) Some fields are system fields which means they should not be used by the application.
      final <Error class: unknown class> expression(String expression) The expression that defines how this Field gets its value.
      final <Error class: unknown class> unit(String unit) Human-readable unit of the field (like 'V' for Volt or '%' for percentage).
      final <Error class: unknown class> fetchGroup(String fetchGroup) An identifier to that can be used to ensure all needed registers are retrieved together.
      final Field build() Build the Field, throws IllegalArgumentException if something is wrong

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Field.FieldBuilder

        Field.FieldBuilder()

    • Method Detail

      • block

         final <Error class: unknown class> block(Block block)

        The block to which this block must be linked

      • id

         final <Error class: unknown class> id(String id)

        The technical id of this field. Must be usable as an identifier in 'all' common programming languages. So "CamelCase" (without spaces) is a good choice.

      • description

         final <Error class: unknown class> description(String description)

        A human-readable description of this field.

      • shortDescription

         final <Error class: unknown class> shortDescription(String shortDescription)

        A shorter variant of the Human-readable description of the field. If no shorter version is available then it will be the same as the 'long' description.

      • immutable

         final <Error class: unknown class> immutable(Boolean immutable)

        If a field NEVER changes then this can be se to true. This allows a library to only read this value the first time and on subsequent updates skip reading this value.

      • system

         final <Error class: unknown class> system(Boolean system)

        Some fields are system fields which means they should not be used by the application.

      • expression

         final <Error class: unknown class> expression(String expression)

        The expression that defines how this Field gets its value.

      • unit

         final <Error class: unknown class> unit(String unit)

        Human-readable unit of the field (like 'V' for Volt or '%' for percentage).

      • fetchGroup

         final <Error class: unknown class> fetchGroup(String fetchGroup)

        An identifier to that can be used to ensure all needed registers are retrieved together. By default, filled with a random unique value or what was dictated by the block

      • build

         final Field build()

        Build the Field, throws IllegalArgumentException if something is wrong