Package io.openems.edge.common.modbusslave

Class ModbusSlaveNatureTable.Builder

java.lang.Object

io.openems.edge.common.modbusslave.ModbusSlaveNatureTable.Builder

Enclosing class:

ModbusSlaveNatureTable

public static class ModbusSlaveNatureTable.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder(Class<?> nature, AccessMode accessModeFilter, int length)

Method Summary

Modifier and Type	Method	Description
ModbusSlaveNatureTable	build()
ModbusSlaveNatureTable.Builder	channel(int offset, ChannelId channelId, ModbusType type)	Add a Channel to the ModbusSlaveNatureTable.Builder.
<T extends OpenemsComponent> ModbusSlaveNatureTable.Builder	cycleValue(int offset, String name, Unit unit, String valueDescription, ModbusType type, Function<T,Object> function)	Add a CycleValue to the ModbusSlaveNatureTable.Builder.
ModbusSlaveNatureTable.Builder	float32(int offset, String name, float value)	Add a Float 32 value to the ModbusSlaveNatureTable ModbusSlaveNatureTable.Builder.
ModbusSlaveNatureTable.Builder	float32Reserved(int offset)	Add a Float 32 Reserved value to the ModbusSlaveNatureTable ModbusSlaveNatureTable.Builder.
ModbusSlaveNatureTable.Builder	float64(int offset, String name, double value)	Add a Float 64 value to the ModbusSlaveNatureTable ModbusSlaveNatureTable.Builder.
ModbusSlaveNatureTable.Builder	float64Reserved(int offset)	Add a Float 64 Reserved value to the ModbusSlaveNatureTable ModbusSlaveNatureTable.Builder.
ModbusSlaveNatureTable.Builder	string16(int offset, String name, String value)	Add a String 16 value to the ModbusSlaveNatureTable ModbusSlaveNatureTable.Builder.
ModbusSlaveNatureTable.Builder	string16Reserved(int offset)	Add a String 16 Reserved value to the ModbusSlaveNatureTable ModbusSlaveNatureTable.Builder.
ModbusSlaveNatureTable.Builder	uint16(int offset, String name, short value)	Add a Unsigned Int 16 value to the ModbusSlaveNatureTable ModbusSlaveNatureTable.Builder.
ModbusSlaveNatureTable.Builder	uint16Hash(int offset, String text)	Add a Unsigned Int 16 Hash value to the ModbusSlaveNatureTable ModbusSlaveNatureTable.Builder.
ModbusSlaveNatureTable.Builder	uint16Reserved(int offset)	Add a Unsigned Int 16 Reserved value to the ModbusSlaveNatureTable ModbusSlaveNatureTable.Builder.
ModbusSlaveNatureTable.Builder	uint32Reserved(int offset)	Add a Unsigned Int 32 Reserved value to the ModbusSlaveNatureTable ModbusSlaveNatureTable.Builder.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(Class<?> nature,
 AccessMode accessModeFilter,
 int length)

Method Details

channel

public ModbusSlaveNatureTable.Builder channel(int offset,
 ChannelId channelId,
 ModbusType type)

Add a Channel to the ModbusSlaveNatureTable.Builder.

Parameters:

offset - the register address offset

channelId - the ChannelId

type - the ModbusType

Returns:

myself

cycleValue

public <T extends OpenemsComponent>
ModbusSlaveNatureTable.Builder cycleValue(int offset,
 String name,
 Unit unit,
 String valueDescription,
 ModbusType type,
 Function<T,Object> function)

Add a CycleValue to the ModbusSlaveNatureTable.Builder.

A ModbusRecordCycleValue allows to receive a ModbusRecord via a Function. The Function is executed in the 'run()' method of the Modbus-TCP-Api-Controller.

Type Parameters:

T - the target OpenemsType

Parameters:

offset - the register address offset

name - the name

unit - the Unit

valueDescription - the value description

type - the ModbusType

function - the Function

Returns:

myself

uint16

public ModbusSlaveNatureTable.Builder uint16(int offset,
 String name,
 short value)

Add a Unsigned Int 16 value to the ModbusSlaveNatureTable ModbusSlaveNatureTable.Builder.

Parameters:

offset - the address offset

name - the name of the register

value - the value

Returns:

myself

uint16Hash

public ModbusSlaveNatureTable.Builder uint16Hash(int offset,
 String text)

Add a Unsigned Int 16 Hash value to the ModbusSlaveNatureTable ModbusSlaveNatureTable.Builder.

Parameters:

offset - the address offset

text - the description text

Returns:

myself

uint16Reserved

public ModbusSlaveNatureTable.Builder uint16Reserved(int offset)

Add a Unsigned Int 16 Reserved value to the ModbusSlaveNatureTable ModbusSlaveNatureTable.Builder.

Parameters:

offset - the address offset

Returns:

myself

uint32Reserved

public ModbusSlaveNatureTable.Builder uint32Reserved(int offset)

Add a Unsigned Int 32 Reserved value to the ModbusSlaveNatureTable ModbusSlaveNatureTable.Builder.

Parameters:

offset - the address offset

Returns:

myself

float32

public ModbusSlaveNatureTable.Builder float32(int offset,
 String name,
 float value)

Add a Float 32 value to the ModbusSlaveNatureTable ModbusSlaveNatureTable.Builder.

Parameters:

offset - the address offset

name - the name of the register

value - the value

Returns:

myself

float32Reserved

public ModbusSlaveNatureTable.Builder float32Reserved(int offset)

Add a Float 32 Reserved value to the ModbusSlaveNatureTable ModbusSlaveNatureTable.Builder.

Parameters:

offset - the address offset

Returns:

myself

float64

public ModbusSlaveNatureTable.Builder float64(int offset,
 String name,
 double value)

Add a Float 64 value to the ModbusSlaveNatureTable ModbusSlaveNatureTable.Builder.

Parameters:

offset - the address offset

name - the name of the register

value - the value

Returns:

myself

float64Reserved

public ModbusSlaveNatureTable.Builder float64Reserved(int offset)

Add a Float 64 Reserved value to the ModbusSlaveNatureTable ModbusSlaveNatureTable.Builder.

Parameters:

offset - the address offset

Returns:

myself

string16

public ModbusSlaveNatureTable.Builder string16(int offset,
 String name,
 String value)

Add a String 16 value to the ModbusSlaveNatureTable ModbusSlaveNatureTable.Builder.

Parameters:

offset - the address offset

name - the name of the register

value - the value

Returns:

myself

string16Reserved

public ModbusSlaveNatureTable.Builder string16Reserved(int offset)

Add a String 16 Reserved value to the ModbusSlaveNatureTable ModbusSlaveNatureTable.Builder.

Parameters:

offset - the address offset

Returns:

myself

build

public ModbusSlaveNatureTable build()