本Class是用于描述XLink数据端点的Model类。属性主要是描述数据端点的一些特征,关键属性是index、type、value等。
另外提供了一些构建方法,还有将数据端点实体转字典等方法。
一、注意事项
三个关键属性index、type、value 必须要正确的和管理台设置的对应上。
另外需要注意的是,value返回的值是泛型数据。具体的数据类型如下:
- 如果type是XLinkDataTypeBool、XLinkDataTypeByte、XLinkDataTypeShort、XLinkDataTypeInt、XLinkDataTypeFloat、XLinkDataTypeUnsignedShort、XLinkDataTypeUnsignedInt,那么value应该是NSNumber类型;
- 如果type是XLinkDataTypeString,那么value应该是NSString类型;
- 如果type是XLinkDataTypeByteArray,那么value应该是NSData类型;
二、属性列表
参数名称 | 描述 | 类型 |
---|---|---|
type | 数据端点值数据类型 | XLinkDataType |
index | 数据端点索引 | uint_8 |
value | 数据端点的值 | 泛型,根据具体的type决定 |
maxValue | 数据端点最大值 | long long |
minValue | 数据端点最小值 | long long |
name | 数据端点名称 | NSString |
dataPointDesc | 数据端点描述 | NSString |
symbol | 数据端点符号 | NSString |
isRead | 数据端点是否可读 | BOOL |
isWrite | 数据端点是否可写 | BOOL |
isCollect | 是否收集端点数据 | BOOL |
defaultValue | 默认值 | NSString |
expression | 动态计算数据端点表达式 | NSString |
source | 数据端点来源类型 | uint16_t |
三、API 列表
1. 通过字典还原成数据端点实体
- (instancetype)initWithDictionary:(NSDictionary *)dic
支持的版本
开始支持的版本:6.0
注意事项
传入的字典对象需要是通过getDictionaryFormat获取的,不然可能有问题。
输入参数
具体的接口输入参数描述如下:
参数名称 | 类型 | 描述 | 必选 |
---|---|---|---|
dic | NSDictionary | 数据端点字典 | 是 |
输出参数
无
错误码
无
2. 将数据端点属性格式化成字典
- (NSDictionary *)getDictionaryFormat
支持的版本
开始支持的版本:6.0
注意事项
无
输入参数
无
输出参数
具体的接口输出参数描述如下:
描述 | 类型 | 必选 |
---|---|---|
数据端点字典 | NSDictionary | 是 |
错误码
无