Class Block
-
- All Implemented Interfaces:
public class Block
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classBlock.BlockBuilder
-
Field Summary
Fields Modifier and Type Field Description private final Stringidprivate StringfetchGroupprivate AddressClassaddressClassprivate final List<Field>fieldsprivate final SchemaDeviceschemaDeviceprivate final Stringdescription
-
Constructor Summary
Constructors Constructor Description Block(SchemaDevice schemaDevice, String id, String description)
-
Method Summary
Modifier and Type Method Description final StringgetId()The technical id of the block. final StringgetFetchGroup()An identifier to that can be used to ensure all needed registers are retrieved together. final UnitsetFetchGroup(String fetchGroup)An identifier to that can be used to ensure all needed registers are retrieved together. final AddressClassgetAddressClass()A block is limited to a single AddressClass. final UnitsetAddressClass(AddressClass addressClass)A block is limited to a single AddressClass. final List<Field>getFields()final SchemaDevicegetSchemaDevice()The schema device of which this block is a part final StringgetDescription()The human-readable description of the block. final BlockaddField(Field fields)final FieldgetField(String fieldName)final Fieldget(String fieldId)final UnitsortFieldsByAddress()final Booleaninitialize()Verify the basics final UnittoTable(StringTable table, Boolean onlyUseFullFields)StringtoString()final Unitupdate()Directly update all fields in this Block final Unitneed()All fields in this Block must be kept up-to-date final UnitunNeed()All fields in this Block no longer need to be kept up-to-date final static Block.BlockBuilderbuilder()-
-
Constructor Detail
-
Block
Block(SchemaDevice schemaDevice, String id, String description)
-
-
Method Detail
-
getId
final String getId()
The technical id of the block. Must be usable as an identifier in 'all' common programming languages. So "CamelCase" (without spaces, starting with a letter) is a good choice.
-
getFetchGroup
final String getFetchGroup()
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
-
setFetchGroup
final Unit setFetchGroup(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
-
getAddressClass
final AddressClass getAddressClass()
A block is limited to a single AddressClass.
-
setAddressClass
final Unit setAddressClass(AddressClass addressClass)
A block is limited to a single AddressClass.
-
getSchemaDevice
final SchemaDevice getSchemaDevice()
The schema device of which this block is a part
-
getDescription
final String getDescription()
The human-readable description of the block.
-
sortFieldsByAddress
final Unit sortFieldsByAddress()
-
initialize
final Boolean initialize()
Verify the basics
-
toTable
final Unit toTable(StringTable table, Boolean onlyUseFullFields)
-
builder
final static Block.BlockBuilder builder()
-
-
-
-