Skip to content

Commit 80e0119

Browse files
committed
update example readme
1 parent a673775 commit 80e0119

File tree

2 files changed

+270
-310
lines changed

2 files changed

+270
-310
lines changed

help/NEVSTOP/Communicable State Machine(CSM)/Examples/Addons - API String Arguments Support(CN).md

Lines changed: 89 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -4,76 +4,76 @@
44

55
### Overview
66

7-
本文展示了CSM API参数中支持的空字符串转换为典型数据类型的示例。空字符串在大多数情况下会被转换为参考数据类型连接的数值。例外场景:
7+
本范例展示了CSM API参数中支持的空字符串转换为典型数据类型的示例。空字符串在大多数情况下会被转换为参考数据类型连接的数值。例外场景:
88

9-
- String 数据类型:空字符串会被转换为空字符串。
9+
- **String数据类型:**空字符串会被转换为空字符串。
1010

1111
### Introduction
1212

13-
展示不同的空字符串转换为典型数据类型的示例。特别注意 String 数据类型的例外情况。界面会显示参考值和转换后的值,供用户比较。
13+
展示不同的空字符串转换为典型数据类型的示例。特别注意String数据类型的例外情况。界面会显示参考值和转换后的值,供用户比较。
1414

1515
### Steps
1616

1717
- step1: 所有的普通类型,空字符串会被转换为参考数据类型连接的数值。
1818
- step2: String 数据类型,空字符串会被转换为空字符串。
19-
- step3: timestamp 数据类型,空字符串会转换为当前时间。
19+
- step3: Timestamp 数据类型,空字符串会转换为当前时间。
2020

2121
## 2. CSM API String to Typical datatypes.vi
2222

2323
### Overview
2424

25-
本文展示了CSM API参数中支持的典型数据类型转换为字符串的示例
25+
本范例展示了CSM API参数中支持的字符串转换为典型数据类型的示例
2626

2727
### Introduction
2828

29-
本文展示了一些典型的字符串转换为典型的数据类型的实例
29+
本范例展示了一些典型的字符串转换为典型的数据类型的实例
3030

3131
### Steps
3232

33-
- step1: 路径字符串转换为 path 数据类型
33+
- step1: 路径字符串转换为path数据类型
3434
- step2: 字符串数据类型的转换
35-
- step3: 典型的boolean数据类型的描述可以转换为boolean数据类型
36-
- step4: i32 数据类型转换
37-
- step5: dbl 数据类型的转换
38-
- step6: 普通的enum 类型转换
39-
- step7: 具有编号的 enum 数据类型可以只描述枚举字符串
40-
- step8: 具有编号的 enum 数据类型转换也可以描述索引编号
35+
- step3: 典型的Boolean数据类型的描述可以转换为Boolean数据类型
36+
- step4: i32数据类型转换
37+
- step5: DBL数据类型的转换
38+
- step6: 普通的enum类型转换
39+
- step7: 具有编号的enum数据类型可以只描述枚举字符串
40+
- step8: 具有编号的enum数据类型转换也可以描述索引编号
4141
- step9: 一维数组类型转换
42-
- step10:cluster数据类型转换
43-
- step11: cluster array 数据类型转换
42+
- step10: Cluster数据类型转换
43+
- step11: Cluster array数据类型转换
4444
- step12: 二维数组类型转换
4545

4646

4747
## 3. Incorrect usage collections.vi
4848

49-
### overview
49+
### Overview
5050

51-
一些不正确的API String 描述情况
51+
本范例演示一些不正确的API String描述情况
5252

5353
### Instruction
5454

55-
选择 Action 后,运行 VI 并查看结果,不正确的格式转换后与预期数据不匹配。
55+
选择**Action**后,运行VI并查看结果,不正确的格式转换后与预期数据不匹配。
5656

5757
### Introduction
5858

59-
Cluster 数据类型是重点描述的情况,因为它的情况比较多。通常它的描述格式是
59+
Cluster数据类型是重点描述的情况,因为它的情况比较多。通常cluster数据类型的描述格式是
6060

61-
1. 标签-数据对(Tag:Value)模式
61+
1. 标签-数据对Tag:Value模式
6262
2. 无标签模式
6363

64-
本范例演示了一些不正确的API String 描述情况
64+
本范例演示了一些不正确的API String描述情况
6565

6666
## 常见普通类型数据的转换
6767

6868
### Float 类型(4.1 CSM API String to Float.vi)
6969

7070
#### Overview
7171

72-
API String 支持的Float 格式包括:普通浮点数、科学计数法以及特殊浮点数。本范例演示了这些格式的转换。
72+
API String支持的Float格式包括:普通浮点数、科学计数法以及特殊浮点数。本范例演示了这些格式的转换。
7373

7474
#### Introduction
7575

76-
API String 支持的Float 格式包括:普通浮点数、科学计数法以及特殊浮点数。本范例演示了这些格式的转换。例如以下方式:
76+
API String支持的Float格式包括:普通浮点数、科学计数法以及特殊浮点数。本范例演示了这些格式的转换。例如以下方式:
7777

7878
```
7979
- 1.2345
@@ -99,9 +99,9 @@ API String 支持的Float 格式包括:普通浮点数、科学计数法以及
9999
```
100100

101101
注意:
102-
- 空字符串将转换为原型(Prototype)的输入值。
102+
- 空字符串将转换为原型Prototype的输入值。
103103
- 默认精度为6位有效数字。可以通过API String - Set Float Precision.vi修改精度。
104-
- 标签-数据对(Tag:Value)可以被正确解析。标签仅用于提高可读性,转换过程中会被忽略。
104+
- 标签-数据对Tag:Value可以被正确解析。标签仅用于提高可读性,转换过程中会被忽略。
105105

106106
#### Steps
107107

@@ -113,74 +113,82 @@ API String 支持的Float 格式包括:普通浮点数、科学计数法以及
113113

114114
#### Overview
115115

116-
演示API String中包含单位的浮点数转换为浮点数的示例。
116+
本范例演示API String中包含单位的浮点数转换为浮点数的示例。
117117

118118
#### Introduction
119119

120-
API String 带有单位的浮点数字符串也支持正确解析
120+
API String带有单位的浮点数字符串也支持正确解析
121121

122122
如果浮点数字符串与单位字符串之间存在空格,则浮点数后面的所有内容(包括符号)都被识别为单位字符串。
123-
例如:1.23mA : 浮点数: 1.23m; 单位: A 1.23 mA : 浮点数: 1.23; 单位: mA
123+
例如:
124+
125+
1.23mA : 浮点数: 1.23m; 单位: A
126+
127+
1.23 mA : 浮点数: 1.23; 单位: mA
124128

125129
对于科学计数法表示的浮点数,无论是否存在空格,浮点数后面的字符串都被识别为单位字符串。
126-
例如:1.23E+5mA: 浮点数: 1.23E+5; 单位: mA 1.23E+5 mA: 浮点数: 1.23E+5; 单位: mA
130+
例如:
131+
132+
1.23E+5mA: 浮点数: 1.23E+5; 单位: mA
133+
134+
1.23E+5 mA: 浮点数: 1.23E+5; 单位: mA
127135

128-
e、-e、pi、-pi、inf、+inf、-inf 和 NaN 等特殊浮点数值不支持单位
136+
e、-e、pi、-pi、inf、+inf、-inf和NaN等特殊浮点数值不支持单位
129137

130138
#### Steps
131139

132140
- step1: 不同情况的浮点数单位转换测试
133-
- step2API String中的转换依赖于 String To Float_csm.vi,可以在函数选板找到这个函数。
141+
- step2: API String中的转换依赖于String To Float_csm.vi,可以在函数选板找到这个函数。
134142

135143
### 复数(4.3 CSM API String to Complex Numeric.vi)
136144

137145
#### Overview
138146

139-
本范例用于演示 API String 对于复数的支持
147+
本范例用于演示API String对于复数的支持
140148

141149
#### Introduction
142150

143-
API String 支持复数类型。a+bi 或 a-bi 格式表示复数。其中 a 和 b 支持所有浮点数的表达方式
151+
API String支持复数类型。a+bi或a-bi格式表示复数。其中a和b支持所有浮点数的表达方式
144152

145153
特殊情况说明:
146-
- 空字符串将转换为原型(Prototype)的输入值。
147-
- 标签-数据对(Tag:Value)可以被正确解析。标签仅用于提高可读性,转换过程中会被忽略。
154+
- 空字符串将转换为原型Prototype的输入值。
155+
- 标签-数据对Tag:Value可以被正确解析。标签仅用于提高可读性,转换过程中会被忽略。
148156

149-
### Timestamp 类型(4.4 CSM API String to Timestamp.vi)
157+
### Timestamp 类型(4.4 CSM API String to TimeStamp.vi)
150158

151159
#### Overview
152160

153-
本范例用于演示 API String 对于时间戳的支持
161+
本范例用于演示API String对于时间戳的支持
154162

155163
#### Introduction
156164

157-
API String 时间戳的标准格式为:TimeStamp_String(Format_String)。其中 Format_String 用于解析 TimeStamp_String。
165+
API String时间戳的标准格式为:`TimeStamp_String(Format_String)`。其中`Format_String`用于解析`TimeStamp_String`
158166

159167
特殊情况说明:
160-
- 当字符串不包含 Format_String 时,TimeStamp_String 应符合 RFC3339 标准格式
161-
- "2023-10-31T14:49:39.597Z" 为有效的表达方式.
162-
- "2023-10-31T22:49:39.597+08:00" 为有效的表达方式.
168+
- 当字符串不包含`Format_String`时,`TimeStamp_String`应符合RFC3339标准格式
169+
- "`2023-10-31T14:49:39.597Z`" 为有效的表达方式.
170+
- "`2023-10-31T22:49:39.597+08:00`" 为有效的表达方式.
163171
- 对于时间戳,空字符串将转换为当前时间。
164172

165-
#### steps
173+
#### Steps
166174

167175
- step1: 空字符串转换为当前时间
168176
- step2: 标准格式转换为时间戳
169-
- step3: timestamp转换为 API String,并被正确解析回时间戳数据类型
177+
- step3: Timestamp转换为API String,并被正确解析回时间戳数据类型
170178
- step4: TimeStamp_String(Format_String)格式的示例
171179

172180
### Enum 类型(4.5 CSM API String to Enum(special format).vi)
173181

174182
#### Overview
175183

176-
本范例用于演示 API String 对于枚举类型的支持
184+
本范例用于演示API String对于枚举类型的支持
177185

178186
#### Introduction
179187

180-
API String Enum 定义为 [索引编号(index)][分隔符(separator)][枚举字符串] 格式的字符串。
188+
API String Enum 定义为[索引编号(index)\][枚举字符串\]格式的字符串。
181189

182190
- 索引编号支持NUMERIC类型的所有表达方式。例如:0x01,0b0001。
183-
- 分隔符(separator)支持 =,-,_ 三种字符,重复个数不限。
191+
- 分隔符separator支持 =、-、_ 三种字符,重复个数不限。
184192

185193
转换规则:
186194

@@ -210,11 +218,11 @@ API String Enum 定义为 [索引编号(index)][分隔符(separator)][枚举字
210218

211219
#### Overview
212220

213-
本范例用于演示 API String 对于数组类型的支持
221+
本范例用于演示API String对于数组类型的支持
214222

215223
#### Introduction
216224

217-
API String中对于Array 的定义,逗号(,) 用于元素分隔,分号(;) 用于行分隔。方括号([]) 用作边界符号。对于非复杂的混合数据类型,方括号可以省略。
225+
API String中对于Array的定义,逗号(,) 用于元素分隔,分号(;) 用于行分隔。方括号([]) 用作边界符号。对于非复杂的混合数据类型,方括号可以省略。
218226

219227
示例:
220228

@@ -223,47 +231,47 @@ API String中对于Array 的定义,逗号(,) 用于元素分隔,分号(;)
223231

224232
特殊情况说明:
225233

226-
- 空字符串将转换为原型(Prototype)的输入值。
234+
- 空字符串将转换为原型Prototype的输入值。
227235

228236
#### Steps
229237

230-
- step1: 空字符串转换为原型(Prototype)的输入值
238+
- step1: 空字符串转换为原型Prototype的输入值
231239
- step2: 一维数组转换
232240
- step3: 二维数组转换
233241

234242
### 5.2 Cluster 1D Array to CSM API String.vi
235243

236244
#### Overview
237245

238-
本范例用于演示 Cluster 1D Array 的 CSM API String表达。
246+
本范例用于演示Cluster 1D Array的CSM API String表达。
239247

240248
#### Introduction
241249

242-
Array 是一种复合数据类型,可能包含不同的数据类型。其中以 Cluster 最为复杂本范例将展示1D Cluster Array 的 CSM API String 表达字符串
250+
Array是一种复合数据类型,可能包含不同的数据类型,其中以Cluster 最为复杂本范例将展示1D Cluster Array的CSM API String表达字符串
243251

244252
### 5.3 Cluster 2D Array to CSM API String.vi
245253

246254
#### Overview
247255

248-
本范例用于演示 Cluster 2D Array 的 CSM API String表达。
256+
本范例用于演示Cluster 2D Array的CSM API String表达。
249257

250258
#### Introduction
251259

252-
Array 是一种复合数据类型,可能包含不同的数据类型其中以 Cluster 最为复杂本范例将展示2D Cluster Array 的 CSM API String 表达字符串
260+
Array是一种复合数据类型,可能包含不同的数据类型其中以 Cluster 最为复杂本范例将展示2D Cluster Array的CSM API String表达字符串
253261

254262
## Cluster 数据类型支持
255263

256264
### 6.1 Cluster to CSM API String.vi
257265

258266
#### Overview
259267

260-
本范例用于演示 Cluster 的 CSM API String表达。
268+
本范例用于演示Cluster的CSM API String表达。
261269

262270
#### Introduction
263271

264-
Cluster 是一种复杂类型,它由其他的普通数据类型组成。本范例将展示 Cluster 的 CSM API String 表达字符串。在 API String 中,Cluster 可以表达为两种方式
272+
Cluster是一种复杂类型,它由其他的普通数据类型组成。本范例将展示Cluster的CSM API String表达字符串。在API String中,Cluster可以表达为两种方式
265273

266-
1. 标签-数据对(Tag:Value)模式
274+
1. 标签-数据对Tag:Value模式
267275

268276
在标签-数据对模式下,输入字符串由多个标签-数据对组成,冒号(:)用于分隔标签和数据,分号(;)用于分隔不同元素。花括号({ 和 })用作边界符号。对于非复杂的混合数据类型,花括号可以省略。
269277

@@ -273,47 +281,49 @@ Cluster 是一种复杂类型,它由其他的普通数据类型组成。本范
273281

274282
#### Steps
275283

276-
- step1: 标签-数据对(Tag:Value)模式
284+
- step1: 标签-数据对Tag:Value模式
277285
- step2: 无标签模式
278286

279287
### 6.2 CSM API String to Cluster.vi
280288

281289
#### Overview
282290

283-
本范例用于演示 Cluster 的 CSM API String表达。
291+
本范例用于演示Cluster的CSM API String表达。
284292

285293
#### Introduction
286294

287-
Cluster 是一种复杂类型,它由其他的普通数据类型组成。本范例将展示 Cluster 的 CSM API String 表达字符串。在 API String 中,Cluster 可以表达为两种方式
295+
Cluster是一种复杂类型,它由其他的普通数据类型组成。本范例展示Cluster的CSM API String表达字符串。在API String中,Cluster可以表达为两种方式
288296

289-
1. 标签-数据对(Tag:Value)模式
297+
1. 标签-数据对Tag:Value)模式:在标签-数据对模式下,输入字符串由多个标签-数据对组成,冒号(:)用于分隔标签和数据,分号(;)用于分隔不同元素。花括号({ 和 })用作边界符号。对于非复杂的混合数据类型,花括号可以省略。其他规则如下:
290298

291-
在标签-数据对模式下,输入字符串由多个标签-数据对组成,冒号(:)用于分隔标签和数据,分号(;)用于分隔不同元素。花括号({ 和 })用作边界符号。对于非复杂的混合数据类型,花括号可以省略。其他规则如下:
299+
- 标签对应簇中元素的名称,值会根据对应元素的数据类型进行转换。
292300

293-
标签对应簇中元素的名称,值会根据对应元素的数据类型进行转换。
294-
只需描述需要修改的元素,与数据原型一致的元素可以省略。
295-
通过名称匹配元素,顺序无关紧要。
296-
对于嵌套簇,子簇元素的标签格式为"父簇标签.子簇元素标签"。
297-
嵌套簇中,如果子簇元素的标签名称唯一,可以省略父簇的标签。
301+
- 只需描述需要修改的元素,与数据原型一致的元素可以省略。
298302

299-
2. 无标签模式
300303

301-
对于簇,也支持仅输入数据字符串,各值之间用分号分隔。
304+
- 通过名称匹配元素,顺序无关紧要。
305+
302306

303-
顺序非常重要。第一个元素值将设置给簇的第一个元素,第二个元素值设置给簇的第二个元素,以此类推。
304-
如果输入字符串的元素数量少于簇的元素数量,剩余的元素将保持不变。
305-
如果输入字符串的元素数量多于簇的元素数量,多余的元素将被忽略。
307+
- 对于嵌套簇,子簇元素的标签格式为"父簇标签.子簇元素标签"。
308+
309+
310+
- 嵌套簇中,如果子簇元素的标签名称唯一,可以省略父簇的标签。
311+
312+
313+
2. 无标签模式:对于簇,也支持仅输入数据字符串,各值之间用分号分隔。顺序非常重要。第一个元素值将设置给簇的第一个元素,第二个元素值设置给簇的第二个元素,以此类推。
314+
- 如果输入字符串的元素数量少于簇的元素数量,剩余的元素将保持不变。
315+
- 如果输入字符串的元素数量多于簇的元素数量,多余的元素将被忽略。
306316

307317
#### Steps
308318

309319
- step1: 空字符串转换为参考数据
310-
- step2: 可以只通过 tag 名称修改参考数据中的某个元素数据
320+
- step2: 可以只通过tag名称修改参考数据中的某个元素数据
311321
- step3:没有标签且个数只有一个的情况下,将直接修改参考数据的第一个元素数据
312-
- step4: 没有标签且个数只有一个的情况下,将直接修改参考数据的第一个元素数据,第一个是Array的情况
322+
- step4: 没有标签且个数只有一个的情况下,将直接修改参考数据的第一个元素数据第一个是Array的情况
313323
- step5: 无标签模式
314-
- step6: 无标签模式, 但是元素个数小于全部个数
315-
- step7: 可以只通过 tag 名称修改参考数据中的某个元素数据
316-
- step8无标签模式,但是其中的boolean 数据使用了其他的表达方式
324+
- step6: 无标签模式但是元素个数小于全部个数
325+
- step7: 可以只通过tag名称修改参考数据中的某个元素数据
326+
- step8: 无标签模式,但是其中的boolean 数据使用了其他的表达方式
317327
- step9: 无标签模式,但是元素个数大于全部个数
318328
- step10: 多层嵌套下,tag的名称可以包含点号(.),用于表示嵌套簇的层级, 没有歧义的情况下,可以只写最终元素的名称,或者部分子嵌套层级的名称
319329

@@ -323,14 +333,10 @@ Cluster 是一种复杂类型,它由其他的普通数据类型组成。本范
323333

324334
#### Overview
325335

326-
通常 Array/Cluster 的嵌套是一个复杂的情况,本范例将展示复杂的Cluster Array 的 CSM API String 表达字符串。但是者并不是一个典型的推荐使用场景
336+
通常Array/Cluster的嵌套是一个复杂的情况,本范例展示复杂的Cluster Array的CSM API String表达字符串。但是这并不是一个典型的推荐使用场景
327337

328338
### 7.2 Cluster with 2D Array elements.vi
329339

330340
#### Overview
331341

332-
通常 Array/Cluster 的嵌套是一个复杂的情况,本范例将展示2D Cluster Array 的 CSM API String 表达字符串。但是者并不是一个典型的推荐使用场景。
333-
334-
335-
336-
342+
通常Array/Cluster的嵌套是一个复杂的情况,本范例将展示2D Cluster Array的CSM API String表达字符串。但是这并不是一个典型的推荐使用场景。

0 commit comments

Comments
 (0)