All Implemented Interfaces:


public class SchemaDevice

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`SchemaDevice.TestResult`
`public class`	`SchemaDevice.SchemaDeviceBuilder`

Field Summary

Fields
Modifier and Type	Field	Description
`public final static Integer`	`CURRENT_SCHEMA_FEATURE_LEVEL`
`private Integer`	`maxRegistersPerModbusRequest`
`private final Integer`	`schemaFeatureLevel`
`private final List<Block>`	`blocks`
`private final Integer`	`maxBlockIdLength`
`private Instant`	`lastFieldModificationTimestamp`
`private ModbusDevice`	`modbusDevice`
`private ModbusBlockFetcher`	`modbusBlockFetcher`
`private final List<Field>`	`fields`
`private final List<TestScenario>`	`tests`
`private String`	`description`

Constructor Summary

Constructors
Constructor	Description
`SchemaDevice(String description, Integer maxRegistersPerModbusRequest)`
`SchemaDevice(String description)`
`SchemaDevice()`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Integer`	`getMaxRegistersPerModbusRequest()`	The maximum number of modbus registers that can be requested PER call.
`final Unit`	`setMaxRegistersPerModbusRequest(Integer maxRegistersPerModbusRequest)`
`final Integer`	`getSchemaFeatureLevel()`	The Modbus Schema level of the schema device.
`final List<Block>`	`getBlocks()`
`final Integer`	`getMaxBlockIdLength()`
`final Instant`	`getLastFieldModificationTimestamp()`	If a field was added or removed this should trigger updates and reinitializations in other parts
`final Unit`	`setLastFieldModificationTimestamp(Instant lastFieldModificationTimestamp)`	If a field was added or removed this should trigger updates and reinitializations in other parts
`final ModbusDevice`	`getModbusDevice()`
`final Unit`	`setModbusDevice(ModbusDevice modbusDevice)`
`final ModbusBlockFetcher`	`getModbusBlockFetcher()`
`final Unit`	`setModbusBlockFetcher(ModbusBlockFetcher modbusBlockFetcher)`
`final List<Field>`	`getFields()`
`final List<TestScenario>`	`getTests()`
`final String`	`getDescription()`	A human-readable description of this schema device.
`final Unit`	`setDescription(String description)`	A human-readable description of this schema device.
`final Unit`	`clearModbusBlocks()`
`final ModbusBlock<?, ?, ?>`	`getModbusBlock(AddressClass addressClass)`
`final Unit`	`addBlock(Block newBlock)`
`final Block`	`getBlock(String blockId)`
`final Unit`	`aFieldWasChanged()`
`final Boolean`	`initialize()`	Verify the basics
`final Boolean`	`initializeAndVerify()`	Verify the basics
`final String`	`initializationProblems()`
`final SchemaDevice`	`connectBase(ModbusDevice modbusDevice)`
`final SchemaDevice`	`connect(ModbusDevice modbusDevice, Integer allowedGapReadSize)`
`final SchemaDevice`	`connect(ModbusDevice modbusDevice)`
`final List<ModbusQuery>`	`update(Long maxAge)`	Update all registers related to the needed fields to be updated with a maximum age of the provided milliseconds
`final List<ModbusQuery>`	`update()`	Update all registers related to the needed fields to be updated with a maximum age of the provided milliseconds
`final List<ModbusQuery>`	`update(Field field)`	Update all registers related to the specified field
`final List<ModbusQuery>`	`updateAll(Long maxAge)`	Make sure all registers mentioned in all known fields are retrieved.
`final List<ModbusQuery>`	`updateAll()`	Make sure all registers mentioned in all known fields are retrieved.
`final Unit`	`need(Field field)`
`final Unit`	`unNeed(Field field)`
`final Unit`	`needAll()`	We want all fields to be kept up-to-date
`final Unit`	`unNeedAll()`	We no longer want all fields to be kept up-to-date
`final <Error class: unknown class>`	`neededFields()`	Get the list of needed fields
`final Unit`	`addTestScenario(TestScenario testScenario)`
`final Unit`	`createTestsUsingCurrentRealData()`
`final TestScenarioResultsList`	`verifyProvidedTests()`	Check if the basic parameters of the defined testcases are valid without actually running the tests.
`String`	`toString()`
`final static SchemaDevice.SchemaDeviceBuilder`	`builder()`

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

- Constructor Detail
  - SchemaDevice
```
SchemaDevice(String description, Integer maxRegistersPerModbusRequest)
```
  - SchemaDevice
```
SchemaDevice(String description)
```
  - SchemaDevice
```
SchemaDevice()
```
- Method Detail
  - getMaxRegistersPerModbusRequest
```
 final Integer getMaxRegistersPerModbusRequest()
```
    The maximum number of modbus registers that can be requested PER call. Some devices do not allow the normal max of 125.
  - setMaxRegistersPerModbusRequest
```
 final Unit setMaxRegistersPerModbusRequest(Integer maxRegistersPerModbusRequest)
```
  - getSchemaFeatureLevel
```
 final Integer getSchemaFeatureLevel()
```
    The Modbus Schema level of the schema device. A Modbus Schema level is the set of available converter methods, return types, etc.
    A schema device uses a set of converter methods (i.e. the version)
    A code generator supports a set of converter methods. A schema device with level 5 will work with a code generator that supports level 10 A schema device with level 10 will NOT work with a code generator that supports level 5
  - getBlocks
```
 final List<Block> getBlocks()
```
  - getMaxBlockIdLength
```
 final Integer getMaxBlockIdLength()
```
  - getLastFieldModificationTimestamp
```
 final Instant getLastFieldModificationTimestamp()
```
    If a field was added or removed this should trigger updates and reinitializations in other parts
  - setLastFieldModificationTimestamp
```
 final Unit setLastFieldModificationTimestamp(Instant lastFieldModificationTimestamp)
```
    If a field was added or removed this should trigger updates and reinitializations in other parts
  - getModbusDevice
```
 final ModbusDevice getModbusDevice()
```
  - setModbusDevice
```
 final Unit setModbusDevice(ModbusDevice modbusDevice)
```
  - getModbusBlockFetcher
```
 final ModbusBlockFetcher getModbusBlockFetcher()
```
  - setModbusBlockFetcher
```
 final Unit setModbusBlockFetcher(ModbusBlockFetcher modbusBlockFetcher)
```
  - getFields
```
 final List<Field> getFields()
```
  - getTests
```
 final List<TestScenario> getTests()
```
  - getDescription
```
 final String getDescription()
```
    A human-readable description of this schema device.
  - setDescription
```
 final Unit setDescription(String description)
```
    A human-readable description of this schema device.
  - clearModbusBlocks
```
 final Unit clearModbusBlocks()
```
  - getModbusBlock
```
 final ModbusBlock<?, ?, ?> getModbusBlock(AddressClass addressClass)
```
  - addBlock
```
 final Unit addBlock(Block newBlock)
```
  - getBlock
```
 final Block getBlock(String blockId)
```
  - aFieldWasChanged
```
 final Unit aFieldWasChanged()
```
  - initialize
```
 final Boolean initialize()
```
    Verify the basics
  - initializeAndVerify
```
 final Boolean initializeAndVerify()
```
    Verify the basics
  - initializationProblems
```
 final String initializationProblems()
```
  - connectBase
```
 final SchemaDevice connectBase(ModbusDevice modbusDevice)
```
  - connect
```
@JvmOverloads() final SchemaDevice connect(ModbusDevice modbusDevice, Integer allowedGapReadSize)
```
  - connect
```
@JvmOverloads() final SchemaDevice connect(ModbusDevice modbusDevice)
```
  - update
```
@JvmOverloads() final List<ModbusQuery> update(Long maxAge)
```
    Update all registers related to the needed fields to be updated with a maximum age of the provided milliseconds
    
    Parameters:
    
    maxAge - maximum age of the fields in milliseconds
    
    Returns:
    
    A (possibly empty) list of all fetches that have been done (with duration and status)
  - update
```
@JvmOverloads() final List<ModbusQuery> update()
```
    Update all registers related to the needed fields to be updated with a maximum age of the provided milliseconds
    
    Returns:
    
    A (possibly empty) list of all fetches that have been done (with duration and status)
  - update
```
 final List<ModbusQuery> update(Field field)
```
    Update all registers related to the specified field
    
    Parameters:
    
    field - the Field that must be updated
    
    Returns:
    
    A (possibly empty) list of all fetches that have been done (with duration and status)
  - updateAll
```
@JvmOverloads() final List<ModbusQuery> updateAll(Long maxAge)
```
    Make sure all registers mentioned in all known fields are retrieved.
    
    Returns:
    
    A (possibly empty) list of all fetches that have been done (with duration and status)
  - updateAll
```
@JvmOverloads() final List<ModbusQuery> updateAll()
```
    Make sure all registers mentioned in all known fields are retrieved.
    
    Returns:
    
    A (possibly empty) list of all fetches that have been done (with duration and status)
  - need
```
 final Unit need(Field field)
```
    Parameters:
    
    field - The field that must be kept up-to-date
  - unNeed
```
 final Unit unNeed(Field field)
```
    Parameters:
    
    field - The field that no longer needs to be kept up-to-date
  - needAll
```
 final Unit needAll()
```
    We want all fields to be kept up-to-date
  - unNeedAll
```
 final Unit unNeedAll()
```
    We no longer want all fields to be kept up-to-date
  - neededFields
```
 final <Error class: unknown class> neededFields()
```
    Get the list of needed fields
  - addTestScenario
```
 final Unit addTestScenario(TestScenario testScenario)
```
  - createTestsUsingCurrentRealData
```
 final Unit createTestsUsingCurrentRealData()
```
  - verifyProvidedTests
```
 final TestScenarioResultsList verifyProvidedTests()
```
    Check if the basic parameters of the defined testcases are valid without actually running the tests.
  - toString
```
 String toString()
```
  - builder
```
 final static SchemaDevice.SchemaDeviceBuilder builder()
```

Class SchemaDevice

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SchemaDevice

SchemaDevice

SchemaDevice

Method Detail

getMaxRegistersPerModbusRequest

setMaxRegistersPerModbusRequest

getSchemaFeatureLevel

getBlocks

getMaxBlockIdLength

getLastFieldModificationTimestamp

setLastFieldModificationTimestamp

getModbusDevice

setModbusDevice

getModbusBlockFetcher

setModbusBlockFetcher

getFields

getTests

getDescription

setDescription

clearModbusBlocks

getModbusBlock

addBlock

getBlock

aFieldWasChanged

initialize

initializeAndVerify

initializationProblems

connectBase

connect

connect

update

update

update

updateAll

updateAll

need

unNeed

needAll

unNeedAll

neededFields

addTestScenario

createTestsUsingCurrentRealData

verifyProvidedTests

toString

builder