IReadWriteNet (com.github.dathlin:HslCommunication 3.4.0 API)

所有已知子接口:

IDelta, IModbus, IReadWriteDevice, IReadWriteMc

所有已知实现类:

AllenBradleyMicroCip, AllenBradleyNet, AllenBradleyPcccNet, AllenBradleySLCNet, DeltaSerialOverTcp, DeltaTcpNet, FanucInterfaceNet, FatekProgramOverTcp, FujiSPBOverTcp, FujiSPHNet, GeSRTPNet, InovanceSerialOverTcp, InovanceTcpNet, KeyenceMcAsciiNet, KeyenceMcNet, KeyenceNanoSerialOverTcp, MelsecA1EAsciiNet, MelsecA1ENet, MelsecFxSerialOverTcp, MelsecMcAsciiNet, MelsecMcAsciiUdp, MelsecMcNet, MelsecMcRNet, MelsecMcUdp, ModbusRtuOverTcp, ModbusTcpNet, ModbusTcpServer, ModbusUdpNet, NetworkConnectedCip, NetworkDataServerBase, NetworkDeviceBase, NetworkUdpDeviceBase, OmronCipNet, OmronConnectedCipNet, OmronFinsNet, OmronFinsUdp, OmronHostLinkCModeOverTcp, OmronHostLinkOverTcp, PanasonicMcNet, PanasonicMewtocolOverTcp, SiemensFetchWriteNet, SiemensPPIOverTcp, SiemensS7Net, XinJESerialOverTcp, XinJETcpNet, YokogawaLinkTcp
```
public interface IReadWriteNet
```
所有的和设备或是交互类统一读写标准，公开了如何读写对方的一些api接口，并支持基于特性的读写操作
All unified read and write standards for devices and interaction classes, expose how to read and write some API interfaces of each other, and support feature-based read and write operations

字段概要

字段
限定符和类型字段和说明

static ILogNet LogNet
当前读写交互类的日志信息，实例化之后，就可以看到系统运行的详细信息。

字段
限定符和类型	字段和说明
`static ILogNet`	`LogNet` 当前读写交互类的日志信息，实例化之后，就可以看到系统运行的详细信息。

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`OperateResult`	`ConnectClose()` 关闭连接
`String`	`getConnectionId()` 当前连接的唯一ID号，默认为长度20的guid码加随机数组成，方便列表管理，也可以自己指定 The unique ID number of the current connection.
`OperateResultExOne<byte[]>`	`Read(String address, short length)` 批量读取字节数组信息，需要指定地址和长度，返回原始的字节数组 Batch read byte array information, need to specify the address and length, return the original byte array
`OperateResultExOne<Boolean>`	`ReadBool(String address)` 读取单个的 `Boolean` 数据信息 Read a single `Boolean` data message
`OperateResultExOne<boolean[]>`	`ReadBool(String address, short length)` 批量读取 `Boolean` 数组信息，需要指定地址和长度，返回 `Boolean` 数组 Batch read `Boolean` array information, need to specify the address and length, return `Boolean` array
`<T extends IDataTransfer> OperateResultExOne<T>`	`ReadCustomer(String address, Class<T> tClass)` 读取自定义的数据类型，需要继承自IDataTransfer接口
`OperateResultExOne<Double>`	`ReadDouble(String address)` 读取双浮点的数据 Read double floating point data
`OperateResultExOne<double[]>`	`ReadDouble(String address, short length)` 读取双浮点数据的数组 Read double floating point data array
`OperateResultExOne<Float>`	`ReadFloat(String address)` 读取单浮点数据 Read single floating point data
`OperateResultExOne<float[]>`	`ReadFloat(String address, short length)` 读取单浮点精度的数组 Read single floating point array
`OperateResultExOne<Short>`	`ReadInt16(String address)` 读取16位的有符号的整型数据 Read 16-bit signed integer data
`OperateResultExOne<short[]>`	`ReadInt16(String address, short length)` 读取16位的有符号整型数组 Read 16-bit signed integer array
`OperateResultExOne<Integer>`	`ReadInt32(String address)` 读取32位的有符号整型 Read 32-bit signed integer
`OperateResultExOne<int[]>`	`ReadInt32(String address, short length)` 读取32位有符号整型数组 Read 32-bit signed integer array
`OperateResultExOne<Long>`	`ReadInt64(String address)` 读取64位的有符号整型 Read 64-bit signed integer
`OperateResultExOne<long[]>`	`ReadInt64(String address, short length)` 读取64位的有符号整型数组 Read 64-bit signed integer array
`OperateResultExOne<String>`	`ReadString(String address, short length)` 读取字符串数据，默认为最常见的ASCII编码 Read string data, default is the most common ASCII encoding
`OperateResultExOne<String>`	`ReadString(String address, short length, Charset encoding)` 使用指定的编码，读取字符串数据 Reads string data using the specified encoding
`OperateResultExOne<Integer>`	`ReadUInt16(String address)` 读取16位的无符号整型 Read 16-bit unsigned integer
`OperateResultExOne<int[]>`	`ReadUInt16(String address, short length)` 读取16位的无符号整型数组 Read 16-bit unsigned integer array
`OperateResultExOne<Long>`	`ReadUInt32(String address)` 读取32位的无符号整型 Read 32-bit unsigned integer
`OperateResultExOne<long[]>`	`ReadUInt32(String address, short length)` 读取32位的无符号整型数组 Read 32-bit unsigned integer array
`void`	`setConnectionId(String connectionId)` 设置当前的连接ID
`OperateResult`	`Write(String address, boolean value)` 写入单个的 `Boolean` 数据，返回是否成功 Write a single `Boolean` data, and return whether the write was successful
`OperateResult`	`Write(String address, boolean[] value)` 批量写入 `Boolean` 数组数据，返回是否成功 Batch write `Boolean` array data, return whether the write was successful
`OperateResult`	`Write(String address, byte[] value)` 写入原始的byte数组数据到指定的地址，返回是否写入成功 Write the original byte array data to the specified address, and return whether the write was successful
`OperateResult`	`Write(String address, double value)` 写入double数据，返回是否成功 Write double data, return whether the write was successful
`OperateResult`	`Write(String address, double[] values)` 写入double数组，返回是否成功 Write double array, return whether the write was successful
`OperateResult`	`Write(String address, float value)` 写入float数据，返回是否成功 Write float data, return whether the write was successful
`OperateResult`	`Write(String address, float[] values)` 写入float数组，返回是否成功 Write float array, return whether the write was successful
`OperateResult`	`Write(String address, int value)` 写入int数据，返回是否成功 Write int data, return whether the write was successful
`OperateResult`	`Write(String address, int[] values)` 写入int[]数组，返回是否成功 Write int array, return whether the write was successful
`OperateResult`	`Write(String address, long value)` 写入long数据，返回是否成功 Write long data, return whether the write was successful
`OperateResult`	`Write(String address, long[] values)` 写入long数组，返回是否成功 Write long array, return whether the write was successful
`OperateResult`	`Write(String address, short value)` 写入short数据，返回是否成功 Write short data, returns whether success
`OperateResult`	`Write(String address, short[] values)` 写入short数组，返回是否成功 Write short array, return whether the write was successful
`OperateResult`	`Write(String address, String value)` 写入字符串信息，编码为ASCII Write string information, encoded as ASCII
`OperateResult`	`Write(String address, String value, Charset encoding)` 写入字符串信息，需要指定的编码信息 Write string information, need to specify the encoding information
`OperateResult`	`Write(String address, String value, int length)` 写入指定长度的字符串信息，如果超出，就截断字符串，如果长度不足，那就补0操作，编码为ASCII Write string information of the specified length.
`OperateResult`	`Write(String address, String value, int length, Charset encoding)` 写入指定长度的字符串信息，如果超出，就截断字符串，如果长度不足，那就补0操作，编码为指定的编码信息 Write string information of the specified length.
`<T extends IDataTransfer> OperateResult`	`WriteCustomer(String address, T value)` 写入自定义类型的数据，该类型必须继承自IDataTransfer接口

- 字段详细资料
  - LogNet
```
static final ILogNet LogNet
```
    当前读写交互类的日志信息，实例化之后，就可以看到系统运行的详细信息。
    Currently read and write interactive log information. After instantiation, you can see detailed information about system operation.
- 方法详细资料
  - getConnectionId
```
String getConnectionId()
```
    当前连接的唯一ID号，默认为长度20的guid码加随机数组成，方便列表管理，也可以自己指定
    The unique ID number of the current connection. The default is a 20-digit guid code plus a random number.
    
    返回:
    
    字符串信息
  - setConnectionId
```
void setConnectionId(String connectionId)
```
    设置当前的连接ID
    
    参数:
    
    connectionId - 设置的数据信息
  - Read
```
OperateResultExOne<byte[]> Read(String address,
                                short length)
```
    批量读取字节数组信息，需要指定地址和长度，返回原始的字节数组
    Batch read byte array information, need to specify the address and length, return the original byte array
    
    参数:
    
    address - 数据地址
    
    length - 数据长度
    
    返回:
    
    带有成功标识的byte[]数组
  - Write
```
OperateResult Write(String address,
                    byte[] value)
```
    写入原始的byte数组数据到指定的地址，返回是否写入成功
    Write the original byte array data to the specified address, and return whether the write was successful
    
    参数:
    
    address - 起始地址
    
    value - 写入值
    
    返回:
    
    带有成功标识的结果类对象
  - ReadBool
```
OperateResultExOne<boolean[]> ReadBool(String address,
                                       short length)
```
    批量读取 Boolean 数组信息，需要指定地址和长度，返回 Boolean 数组
    Batch read Boolean array information, need to specify the address and length, return Boolean array
    
    参数:
    
    address - 数据地址
    
    length - 数据长度
    
    返回:
    
    带有成功标识的boolean[]数组
  - ReadBool
```
OperateResultExOne<Boolean> ReadBool(String address)
```
    读取单个的 Boolean 数据信息
    Read a single Boolean data message
    
    参数:
    
    address - 数据地址
    
    返回:
    
    带有成功标识的boolean值
  - Write
```
OperateResult Write(String address,
                    boolean[] value)
```
    批量写入 Boolean 数组数据，返回是否成功
    Batch write Boolean array data, return whether the write was successful
    
    参数:
    
    address - 起始地址
    
    value - 写入值
    
    返回:
    
    是否写入成功
  - Write
```
OperateResult Write(String address,
                    boolean value)
```
    写入单个的 Boolean 数据，返回是否成功
    Write a single Boolean data, and return whether the write was successful
    
    参数:
    
    address - 起始地址
    
    value - 写入值
    
    返回:
    
    是否写入成功
  - ReadInt16
```
OperateResultExOne<Short> ReadInt16(String address)
```
    读取16位的有符号的整型数据
    Read 16-bit signed integer data
    
    参数:
    
    address - 起始地址
    
    返回:
    
    带有成功标识的short数据
  - ReadInt16
```
OperateResultExOne<short[]> ReadInt16(String address,
                                      short length)
```
    读取16位的有符号整型数组
    Read 16-bit signed integer array
    
    参数:
    
    address - 起始地址
    
    length - 读取的数组长度
    
    返回:
    
    带有成功标识的short数组
  - ReadUInt16
```
OperateResultExOne<Integer> ReadUInt16(String address)
```
    读取16位的无符号整型
    Read 16-bit unsigned integer
    
    参数:
    
    address - 起始地址
    
    返回:
    
    带有成功标识的 ushort 数据
  - ReadUInt16
```
OperateResultExOne<int[]> ReadUInt16(String address,
                                     short length)
```
    读取16位的无符号整型数组
    Read 16-bit unsigned integer array
    
    参数:
    
    address - 起始地址
    
    length - 读取的数组长度
    
    返回:
    
    带有成功标识的 ushort 数组
  - ReadInt32
```
OperateResultExOne<Integer> ReadInt32(String address)
```
    读取32位的有符号整型
    Read 32-bit signed integer
    
    参数:
    
    address - 起始地址
    
    返回:
    
    带有成功标识的int数据
  - ReadInt32
```
OperateResultExOne<int[]> ReadInt32(String address,
                                    short length)
```
    读取32位有符号整型数组
    Read 32-bit signed integer array
    
    参数:
    
    address - 起始地址
    
    length - 数组长度
    
    返回:
    
    带有成功标识的int数组
  - ReadUInt32
```
OperateResultExOne<Long> ReadUInt32(String address)
```
    读取32位的无符号整型
    Read 32-bit unsigned integer
    
    参数:
    
    address - 起始地址
    
    返回:
    
    带有成功标识的uint数据
  - ReadUInt32
```
OperateResultExOne<long[]> ReadUInt32(String address,
                                      short length)
```
    读取32位的无符号整型数组
    Read 32-bit unsigned integer array
    
    参数:
    
    address - 起始地址
    
    length - 数组长度
    
    返回:
    
    带有成功标识的uint数组
  - ReadInt64
```
OperateResultExOne<Long> ReadInt64(String address)
```
    读取64位的有符号整型
    Read 64-bit signed integer
    
    参数:
    
    address - 起始地址
    
    返回:
    
    带有成功标识的long数据
  - ReadInt64
```
OperateResultExOne<long[]> ReadInt64(String address,
                                     short length)
```
    读取64位的有符号整型数组
    Read 64-bit signed integer array
    
    参数:
    
    address - 起始地址
    
    length - 数组长度
    
    返回:
    
    带有成功标识的long数组
  - ReadFloat
```
OperateResultExOne<Float> ReadFloat(String address)
```
    读取单浮点数据
    Read single floating point data
    
    参数:
    
    address - 起始地址
    
    返回:
    
    带有成功标识的float数据
  - ReadFloat
```
OperateResultExOne<float[]> ReadFloat(String address,
                                      short length)
```
    读取单浮点精度的数组
    Read single floating point array
    
    参数:
    
    address - 起始地址
    
    length - 数组长度
    
    返回:
    
    带有成功标识的float数组
  - ReadDouble
```
OperateResultExOne<Double> ReadDouble(String address)
```
    读取双浮点的数据
    Read double floating point data
    
    参数:
    
    address - 起始地址
    
    返回:
    
    带有成功标识的double数据
  - ReadDouble
```
OperateResultExOne<double[]> ReadDouble(String address,
                                        short length)
```
    读取双浮点数据的数组
    Read double floating point data array
    
    参数:
    
    address - 起始地址
    
    length - 数组长度
    
    返回:
    
    带有成功标识的double数组
  - ReadString
```
OperateResultExOne<String> ReadString(String address,
                                      short length)
```
    读取字符串数据，默认为最常见的ASCII编码
    Read string data, default is the most common ASCII encoding
    
    参数:
    
    address - 起始地址
    
    length - 数据长度
    
    返回:
    
    带有成功标识的string数据
  - ReadString
```
OperateResultExOne<String> ReadString(String address,
                                      short length,
                                      Charset encoding)
```
    使用指定的编码，读取字符串数据
    Reads string data using the specified encoding
    
    参数:
    
    address - 起始地址
    
    length - 数据长度
    
    encoding - 指定的自定义的编码
    
    返回:
    
    带有成功标识的string数据
  - ReadCustomer
```
<T extends IDataTransfer> OperateResultExOne<T> ReadCustomer(String address,
                                                             Class<T> tClass)
```
    读取自定义的数据类型，需要继承自IDataTransfer接口
    
    类型参数:
    
    T - 自定义的类型
    
    参数:
    
    address - 起始地址
    
    返回:
    
    带有成功标识的自定义类型数据
  - Write
```
OperateResult Write(String address,
                    short value)
```
    写入short数据，返回是否成功
    Write short data, returns whether success
    
    参数:
    
    address - 起始地址
    
    value - 写入值
    
    返回:
    
    带有成功标识的结果类对象
  - Write
```
OperateResult Write(String address,
                    short[] values)
```
    写入short数组，返回是否成功
    Write short array, return whether the write was successful
    
    参数:
    
    address - 起始地址
    
    values - 写入值
    
    返回:
    
    带有成功标识的结果类对象
  - Write
```
OperateResult Write(String address,
                    int value)
```
    写入int数据，返回是否成功
    Write int data, return whether the write was successful
    
    参数:
    
    address - 起始地址
    
    value - 写入值
    
    返回:
    
    带有成功标识的结果类对象
  - Write
```
OperateResult Write(String address,
                    int[] values)
```
    写入int[]数组，返回是否成功
    Write int array, return whether the write was successful
    
    参数:
    
    address - 起始地址
    
    values - 写入值
    
    返回:
    
    带有成功标识的结果类对象
  - Write
```
OperateResult Write(String address,
                    long value)
```
    写入long数据，返回是否成功
    Write long data, return whether the write was successful
    
    参数:
    
    address - 起始地址
    
    value - 写入值
    
    返回:
    
    带有成功标识的结果类对象
  - Write
```
OperateResult Write(String address,
                    long[] values)
```
    写入long数组，返回是否成功
    Write long array, return whether the write was successful
    
    参数:
    
    address - 起始地址
    
    values - 写入值
    
    返回:
    
    带有成功标识的结果类对象
  - Write
```
OperateResult Write(String address,
                    float value)
```
    写入float数据，返回是否成功
    Write float data, return whether the write was successful
    
    参数:
    
    address - 起始地址
    
    value - 写入值
    
    返回:
    
    带有成功标识的结果类对象
  - Write
```
OperateResult Write(String address,
                    float[] values)
```
    写入float数组，返回是否成功
    Write float array, return whether the write was successful
    
    参数:
    
    address - 起始地址
    
    values - 写入值
    
    返回:
    
    带有成功标识的结果类对象
  - Write
```
OperateResult Write(String address,
                    double value)
```
    写入double数据，返回是否成功
    Write double data, return whether the write was successful
    
    参数:
    
    address - 起始地址
    
    value - 写入值
    
    返回:
    
    带有成功标识的结果类对象
  - Write
```
OperateResult Write(String address,
                    double[] values)
```
    写入double数组，返回是否成功
    Write double array, return whether the write was successful
    
    参数:
    
    address - 起始地址
    
    values - 写入值
    
    返回:
    
    带有成功标识的结果类对象
  - Write
```
OperateResult Write(String address,
                    String value)
```
    写入字符串信息，编码为ASCII
    Write string information, encoded as ASCII
    
    参数:
    
    address - 起始地址
    
    value - 写入值
    
    返回:
    
    带有成功标识的结果类对象
  - Write
```
OperateResult Write(String address,
                    String value,
                    int length)
```
    写入指定长度的字符串信息，如果超出，就截断字符串，如果长度不足，那就补0操作，编码为ASCII
    Write string information of the specified length. If it exceeds the value, the string is truncated. If the length is not enough, it is filled with 0 and the encoding is ASCII.
    
    参数:
    
    address - 起始地址
    
    value - 写入值
    
    length - 写入的字符串的长度
    
    返回:
    
    带有成功标识的结果类对象
  - Write
```
OperateResult Write(String address,
                    String value,
                    Charset encoding)
```
    写入字符串信息，需要指定的编码信息
    Write string information, need to specify the encoding information
    
    参数:
    
    address - 起始地址
    
    value - 写入值
    
    encoding - 指定的编码信息
    
    返回:
    
    带有成功标识的结果类对象
  - Write
```
OperateResult Write(String address,
                    String value,
                    int length,
                    Charset encoding)
```
    写入指定长度的字符串信息，如果超出，就截断字符串，如果长度不足，那就补0操作，编码为指定的编码信息
    Write string information of the specified length. If it exceeds the value, the string is truncated. If the length is not enough, then the operation is complemented with 0 , you should specified the encoding information
    
    参数:
    
    address - 起始地址
    
    value - 写入值
    
    length - 字符串的长度
    
    encoding - 指定的编码信息
    
    返回:
    
    带有成功标识的结果类对象
  - WriteCustomer
```
<T extends IDataTransfer> OperateResult WriteCustomer(String address,
                                                      T value)
```
    写入自定义类型的数据，该类型必须继承自IDataTransfer接口
    
    类型参数:
    
    T - 类型对象
    
    参数:
    
    address - 起始地址
    
    value - 写入值
    
    返回:
    
    带有成功标识的结果类对象
  - ConnectClose
```
OperateResult ConnectClose()
```
    关闭连接

接口 IReadWriteNet

字段概要

方法概要

字段详细资料

LogNet

方法详细资料

getConnectionId

setConnectionId

Read

Write

ReadBool

ReadBool

Write

Write

ReadInt16

ReadInt16

ReadUInt16

ReadUInt16

ReadInt32

ReadInt32

ReadUInt32

ReadUInt32

ReadInt64

ReadInt64

ReadFloat

ReadFloat

ReadDouble

ReadDouble

ReadString

ReadString

ReadCustomer

Write

Write

Write

Write

Write

Write

Write

Write

Write

Write

Write

Write

Write

Write

WriteCustomer

ConnectClose