Package nl.basjes.modbus.schema
Class Block.BlockBuilder
-
- All Implemented Interfaces:
public class Block.BlockBuilder
-
-
Constructor Summary
Constructors Constructor Description Block.BlockBuilder()
-
Method Summary
Modifier and Type Method Description final Block.BlockBuilderschemaDevice(SchemaDevice schemaDevice)The schema device to which this block must be linked final Block.BlockBuilderid(String id)The technical id of this block. final Block.BlockBuilderdescription(String description)A human-readable description of this block. final Block.BlockBuilderfetchGroup(String fetchGroup)An identifier to that can be used to ensure all needed registers are retrieved together. final Block.BlockBuilderaddressClass(AddressClass addressClass)A block is limited to a single AddressClass. final Blockbuild()Build the SchemaDevice, throws IllegalArgumentException if something is wrong -
-
Method Detail
-
schemaDevice
final Block.BlockBuilder schemaDevice(SchemaDevice schemaDevice)
The schema device to which this block must be linked
-
id
final Block.BlockBuilder id(String id)
The technical id of this block. Must be usable as an identifier in 'all' common programming languages. So "CamelCase" (without spaces) is a good choice.
-
description
final Block.BlockBuilder description(String description)
A human-readable description of this block.
-
fetchGroup
final Block.BlockBuilder fetchGroup(String fetchGroup)
An identifier to that can be used to ensure all needed registers are retrieved together. By default, filled with null to leave maximum fetching freedom. A non-null value means that all fields in this block MUST be fetched in one modbus request
-
addressClass
final Block.BlockBuilder addressClass(AddressClass addressClass)
A block is limited to a single AddressClass.
-
-
-
-