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

java.lang.Object
- HslCommunication.Core.Types.HslHelper

```
public class HslHelper
extends Object
```

构造器概要

构造器
构造器和说明

HslHelper()

构造器
构造器和说明
`HslHelper()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static int`	`CalculateBitStartIndex(String bit)` 根据字符串内容，获取当前的位索引地址，例如输入 6,返回6，输入15，返回15，输入B，返回11
`static int`	`CalculateOccupyLength(int address, int length)` 根据位偏移的地址，长度信息，计算出实际的地址占用长度，地址的进制为 8
`static int`	`CalculateOccupyLength(int address, int length, int hex)` 根据位偏移的地址，长度信息，计算出实际的地址占用长度
`static OperateResultExThree<Integer,Short,Integer>`	`CalculateStartBitIndexAndLength(int addressStart, short length)` 根据当前的位偏移地址及读取位长度信息，计算出实际的字节索引，字节数，字节位偏移
`static OperateResultExTwo<Integer,String>`	`ExtractParameter(String address, String paraName)` 解析地址的附加参数方法，比如你的地址是s=100;D100，可以提取出"s"的值的同时，修改地址本身，如果"s"不存在的话，返回错误的消息内容 The method of parsing additional parameters of the address, for example, if your address is s=100;D100, you can extract the value of "s" and modify the address itself.
`static OperateResultExTwo<Integer,String>`	`ExtractParameter(String address, String paraName, int defaultValue)` 解析地址的附加参数方法，比如你的地址是s=100;D100，可以提取出"s"的值的同时，修改地址本身，如果"s"不存在的话，返回给定的默认值 The method of parsing additional parameters of the address, for example, if your address is s=100;D100, you can extract the value of "s" and modify the address itself.
`static OperateResultExTwo<Integer,String>`	`ExtractStartIndex(String address)` 解析地址的起始地址的方法，比如你的地址是 A[1] , 那么将会返回 1，地址修改为 A，如果不存在起始地址，那么就不修改地址，返回 -1 The method of parsing the starting address of the address, for example, if your address is A[1], then it will return 1, and the address will be changed to A.
`static OperateResultExTwo<IByteTransform,String>`	`ExtractTransformParameter(String address, IByteTransform defaultTransform)` 解析地址的附加 `DataFormat` 参数方法，比如你的地址是format=ABCD;D100，可以提取出"format"的值的同时，修改地址本身，如果"format"不存在的话，返回默认的 `IByteTransform` 对象 Parse the additional `DataFormat` parameter method of the address.
`static OperateResultExTwo<Integer,String>`	`GetBitIndexInformation(String address)` 获取地址信息的位索引，在地址最后一个小数点的位置
`static byte[]`	`GetUTF8Bytes(String message)` 从字符串的内容提取UTF8编码的字节，加了对空的校验
`static OperateResultExTwo<int[],int[]>`	`SplitReadLength(int address, short length, short segment)` 切割当前的地址数据信息，根据读取的长度来分割成多次不同的读取内容，需要指定地址，总的读取长度，切割读取长度 Cut the current address data information, and divide it into multiple different read contents according to the read length.
`static <T> OperateResultExTwo<int[],ArrayList<T[]>>`	`SplitWriteData(Class<T> tClass, int address, T[] value, short segment, int addressLength)` 根据指定的长度切割数据数组，返回地址偏移量信息和数据分割信息

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - HslHelper
```
public HslHelper()
```
- 方法详细资料
  - ExtractParameter
```
public static OperateResultExTwo<Integer,String> ExtractParameter(String address,
                                                                  String paraName,
                                                                  int defaultValue)
```
    解析地址的附加参数方法，比如你的地址是s=100;D100，可以提取出"s"的值的同时，修改地址本身，如果"s"不存在的话，返回给定的默认值
    The method of parsing additional parameters of the address, for example, if your address is s=100;D100, you can extract the value of "s" and modify the address itself. If "s" does not exist, return the given default value
    
    参数:
    
    address - 复杂的地址格式，比如：s=100;D100
    
    paraName - 等待提取的参数名称
    
    defaultValue - 如果提取的参数信息不存在，返回的默认值信息
    
    返回:
    
    总是返回成功
  - ExtractParameter
```
public static OperateResultExTwo<Integer,String> ExtractParameter(String address,
                                                                  String paraName)
```
    解析地址的附加参数方法，比如你的地址是s=100;D100，可以提取出"s"的值的同时，修改地址本身，如果"s"不存在的话，返回错误的消息内容
    The method of parsing additional parameters of the address, for example, if your address is s=100;D100, you can extract the value of "s" and modify the address itself. If "s" does not exist, return the wrong message content
    
    参数:
    
    address - 复杂的地址格式，比如：s=100;D100
    
    paraName - 等待提取的参数名称
    
    返回:
    
    解析后的参数结果内容
  - ExtractStartIndex
```
public static OperateResultExTwo<Integer,String> ExtractStartIndex(String address)
```
    解析地址的起始地址的方法，比如你的地址是 A[1] , 那么将会返回 1，地址修改为 A，如果不存在起始地址，那么就不修改地址，返回 -1
    The method of parsing the starting address of the address, for example, if your address is A[1], then it will return 1, and the address will be changed to A. If the starting address does not exist, then the address will not be changed and return -1
    
    参数:
    
    address - 复杂的地址格式，比如：A[0]
    
    返回:
    
    如果存在，就起始位置，不存在就返回 -1
  - ExtractTransformParameter
```
public static OperateResultExTwo<IByteTransform,String> ExtractTransformParameter(String address,
                                                                                  IByteTransform defaultTransform)
```
    解析地址的附加 DataFormat 参数方法，比如你的地址是format=ABCD;D100，可以提取出"format"的值的同时，修改地址本身，如果"format"不存在的话，返回默认的 IByteTransform 对象
    Parse the additional DataFormat parameter method of the address. For example, if your address is format=ABCD;D100, you can extract the value of "format" and modify the address itself. If "format" does not exist, Return the default IByteTransform object
    
    参数:
    
    address - 复杂的地址格式，比如：format=BADC;D100
    
    defaultTransform - 默认的数据转换信息
    
    返回:
    
    解析后的参数结果内容
  - SplitReadLength
```
public static OperateResultExTwo<int[],int[]> SplitReadLength(int address,
                                                              short length,
                                                              short segment)
```
    切割当前的地址数据信息，根据读取的长度来分割成多次不同的读取内容，需要指定地址，总的读取长度，切割读取长度
    Cut the current address data information, and divide it into multiple different read contents according to the read length. You need to specify the address, the total read length, and the cut read length
    
    参数:
    
    address - 整数的地址信息
    
    length - 读取长度信息
    
    segment - 切割长度信息
    
    返回:
    
    切割结果
  - SplitWriteData
```
public static <T> OperateResultExTwo<int[],ArrayList<T[]>> SplitWriteData(Class<T> tClass,
                                                                          int address,
                                                                          T[] value,
                                                                          short segment,
                                                                          int addressLength)
```
    根据指定的长度切割数据数组，返回地址偏移量信息和数据分割信息
    
    类型参数:
    
    T - 数组类型
    
    参数:
    
    tClass - 数组类型
    
    address - 起始的地址
    
    value - 实际的数据信息
    
    segment - 分割的基本长度
    
    addressLength - 一个地址代表的数据长度
    
    返回:
    
    切割结果内容
  - GetBitIndexInformation
```
public static OperateResultExTwo<Integer,String> GetBitIndexInformation(String address)
```
    获取地址信息的位索引，在地址最后一个小数点的位置
    
    参数:
    
    address - 地址信息
    
    返回:
    
    位索引的位置
  - GetUTF8Bytes
```
public static byte[] GetUTF8Bytes(String message)
```
    从字符串的内容提取UTF8编码的字节，加了对空的校验
    
    参数:
    
    message - 字符串内容
    
    返回:
    
    结果
  - CalculateStartBitIndexAndLength
```
public static OperateResultExThree<Integer,Short,Integer> CalculateStartBitIndexAndLength(int addressStart,
                                                                                          short length)
```
    根据当前的位偏移地址及读取位长度信息，计算出实际的字节索引，字节数，字节位偏移
    
    参数:
    
    addressStart - 起始地址
    
    length - 读取的长度
    
    返回:
    
    分别返回 newStart, byteLength, offset
  - CalculateBitStartIndex
```
public static int CalculateBitStartIndex(String bit)
```
    根据字符串内容，获取当前的位索引地址，例如输入 6,返回6，输入15，返回15，输入B，返回11
    
    参数:
    
    bit - 位字符串
    
    返回:
    
    结束数据
  - CalculateOccupyLength
```
public static int CalculateOccupyLength(int address,
                                        int length)
```
    根据位偏移的地址，长度信息，计算出实际的地址占用长度，地址的进制为 8
    
    参数:
    
    address - 偏移地址
    
    length - 长度信息
    
    返回:
    
    占用的地址长度信息
  - CalculateOccupyLength
```
public static int CalculateOccupyLength(int address,
                                        int length,
                                        int hex)
```
    根据位偏移的地址，长度信息，计算出实际的地址占用长度
    
    参数:
    
    address - 偏移地址
    
    length - 长度信息
    
    hex - 地址的进制信息，一般为8 或是 16
    
    返回:
    
    占用的地址长度信息

类 HslHelper

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

HslHelper

方法详细资料

ExtractParameter

ExtractParameter

ExtractStartIndex

ExtractTransformParameter

SplitReadLength

SplitWriteData

GetBitIndexInformation

GetUTF8Bytes

CalculateStartBitIndexAndLength

CalculateBitStartIndex

CalculateOccupyLength

CalculateOccupyLength