All Implemented Interfaces:: kotlin.Comparable


public final class Field
 implements Comparable<Field>

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`Field.FieldBuilder`

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`id`
`private final ReturnType`	`returnType`
`private String`	`fetchGroup`
`private final Boolean`	`fetchGroupIsDefault`
`private final Boolean`	`initialized`
`private final Expression`	`parsedExpression`
`private final Boolean`	`isSystem`
`private final Boolean`	`isImmutable`
`private final Object`	`value`
`private final String`	`stringValue`
`private final List<String>`	`stringListValue`
`private final Double`	`doubleValue`
`private final Long`	`longValue`
`private final Long`	`valueEpochMs`
`private final List<String>`	`requiredFieldNames`
`private final List<Field>`	`requiredFields`
`private final List<Address>`	`requiredRegisters`
`private Integer`	`neededCount`
`private final List<String>`	`testCompareValue`
`private final Block`	`block`
`private final String`	`description`
`private final String`	`shortDescription`
`private final String`	`expression`
`private final String`	`unit`

Constructor Summary

Constructors
Constructor	Description
`Field(Block block, String id, String description, String shortDescription, Boolean immutable, Boolean system, String expression, String unit, String fetchGroup)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getId()`
`final ReturnType`	`getReturnType()`	The return type that the programming language must support.
`final String`	`getFetchGroup()`
`final Unit`	`setFetchGroup(String fetchGroup)`
`final Boolean`	`getFetchGroupIsDefault()`
`final Boolean`	`getInitialized()`
`final Expression`	`getParsedExpression()`	The parsed version of the expression that is actually executed
`final Boolean`	`isSystem()`	Some fields are system fields which means they should not be used by the application.
`final Boolean`	`isImmutable()`
`final Object`	`getValue()`
`final String`	`getStringValue()`
`final List<String>`	`getStringListValue()`
`final Double`	`getDoubleValue()`
`final Long`	`getLongValue()`
`final Long`	`getValueEpochMs()`
`final List<String>`	`getRequiredFieldNames()`
`final List<Field>`	`getRequiredFields()`
`final List<Address>`	`getRequiredRegisters()`
`final Integer`	`getNeededCount()`
`final Unit`	`setNeededCount(Integer neededCount)`
`final List<String>`	`getTestCompareValue()`
`final Block`	`getBlock()`	The block in which this field is located
`final String`	`getDescription()`	Human-readable description of the field.
`final String`	`getShortDescription()`	A shorter variant of the Human-readable description of the field.
`final String`	`getExpression()`	The expression that defines how this Field gets its value.
`final String`	`getUnit()`	Human-readable unit of the field (like 'V' for Volt or '%' for percentage).
`final Boolean`	`initialize()`
`final List<Address>`	`usedReadErrorAddresses()`
`final Boolean`	`isUsingReadErrorRegisters()`
`final List<Address>`	`usedHardReadErrorAddresses()`
`final Boolean`	`isUsingHardReadErrorRegisters()`
`final List<RegisterBlockFetcher.FetchBatch>`	`update()`	Directly update this field.
`final Unit`	`need()`	This field must be kept up-to-date
`final Unit`	`unNeed()`	The field no longer needs to be kept up-to-date
`final Boolean`	`isNeeded()`
`Integer`	`compareTo(Field other)`
`String`	`toString()`
`final static Field.FieldBuilder`	`builder()`

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

Constructor Detail

Field

Field(Block block, String id, String description, String shortDescription, Boolean immutable, Boolean system, String expression, String unit, String fetchGroup)

Method Detail

getId
```
 final String getId()
```

getReturnType
```
 final ReturnType getReturnType()
```
The return type that the programming language must support.

getFetchGroup
```
 final String getFetchGroup()
```

setFetchGroup

 final Unit setFetchGroup(String fetchGroup)

getFetchGroupIsDefault
```
 final Boolean getFetchGroupIsDefault()
```

getInitialized
```
 final Boolean getInitialized()
```

getParsedExpression
```
 final Expression getParsedExpression()
```
The parsed version of the expression that is actually executed

isSystem
```
 final Boolean isSystem()
```
Some fields are system fields which means they should not be used by the application.

isImmutable
```
 final Boolean isImmutable()
```

getValue
```
 final Object getValue()
```

getStringValue
```
 final String getStringValue()
```

getStringListValue

 final List<String> getStringListValue()

getDoubleValue
```
 final Double getDoubleValue()
```

getLongValue
```
 final Long getLongValue()
```

getValueEpochMs
```
 final Long getValueEpochMs()
```

getRequiredFieldNames

 final List<String> getRequiredFieldNames()

getRequiredFields
```
 final List<Field> getRequiredFields()
```

getRequiredRegisters

 final List<Address> getRequiredRegisters()

getNeededCount
```
 final Integer getNeededCount()
```

setNeededCount

 final Unit setNeededCount(Integer neededCount)

getTestCompareValue

 final List<String> getTestCompareValue()

getBlock
```
 final Block getBlock()
```
The block in which this field is located

getDescription
```
 final String getDescription()
```
Human-readable description of the field.

getShortDescription
```
 final String getShortDescription()
```
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.

getExpression
```
 final String getExpression()
```
The expression that defines how this Field gets its value.

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

initialize
```
 final Boolean initialize()
```

usedReadErrorAddresses

 final List<Address> usedReadErrorAddresses()

isUsingReadErrorRegisters

 final Boolean isUsingReadErrorRegisters()

usedHardReadErrorAddresses

 final List<Address> usedHardReadErrorAddresses()

isUsingHardReadErrorRegisters

 final Boolean isUsingHardReadErrorRegisters()

update
```
 final List<RegisterBlockFetcher.FetchBatch> update()
```
Directly update this field.

Returns:

A (possibly empty) list of all fetches that have been done (with duration and status)

need
```
 final Unit need()
```
This field must be kept up-to-date

unNeed
```
 final Unit unNeed()
```
The field no longer needs to be kept up-to-date

isNeeded
```
 final Boolean isNeeded()
```

compareTo
```
 Integer compareTo(Field other)
```

toString
```
 String toString()
```

builder

 final static Field.FieldBuilder builder()

Class Field

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Field

Method Detail

getId

getReturnType

getFetchGroup

setFetchGroup

getFetchGroupIsDefault

getInitialized

getParsedExpression

isSystem

isImmutable

getValue

getStringValue

getStringListValue

getDoubleValue

getLongValue

getValueEpochMs

getRequiredFieldNames

getRequiredFields

getRequiredRegisters

getNeededCount

setNeededCount

getTestCompareValue

getBlock

getDescription

getShortDescription

getExpression

getUnit

initialize

usedReadErrorAddresses

isUsingReadErrorRegisters

usedHardReadErrorAddresses

isUsingHardReadErrorRegisters

update

need

unNeed

isNeeded

compareTo

toString

builder