csh/playbook
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

♻️ refactor(tsl): rebuild codegen taxonomy

Browse Source 
Move generated builtin and dotnet function docs into the upgraded taxonomy, remove legacy route pages, and regenerate function_index.tsv from markdown headings.
This commit is contained in:
csh
2026-07-07 16:36:08 +08:00
parent 54c1c11e77
commit b6160676b4
763 changed files with 179921 additions and 154583 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/tsl/codegen/dotnet/trading/algo_trade.md
+100
View File
@@ -0,0 +1,100 @@
# 算法交易 / 交易指令扩展及算法交易
### `tsAtGetParamterandDefaultValue(argv, name)`
获得指定策略的缺省参数
| 参数 | 类型 | 说明 |
| ------ | ------ | ---------------------------------------------------------------------------------------------------------------------------- |
| `argv` | array | 数组，与交易网关柜台、账号属性、交易账号、账号密码等相关的字符串数组，输入； |
| `name` | string | 字符串，算法交易策略名称，输入；（算法交易策略由算法交易策略开发人员开发完成后，给每个算法交易策略起一个易于理解的算法名称） |
返回：array
### `tsAtQuery(user_id, password, end_t, query_type, time_out)`
查询账号相关信息，包括资金，持仓等
| 参数 | 类型 | 说明 |
| ------------ | -------- | ---------------------------------- |
| `user_id` | string | 字符串，交易账号，输入； |
| `password` | string | 字符串，交易密码，输入； |
| `end_t` | datetime | 实数，查询日期，输入； |
| `query_type` | any | 整数，查询类型，输入； |
| `time_out` | any | 整数，超时时间（单位毫秒），输入； |
返回：array
### `tsAtQueryByOrderId(user_id, password, end_t, order_id, query_type, time_out)`
策略执行结果详情查询（按订单号）
| 参数 | 类型 | 说明 |
| ------------ | -------- | -------------------------------------------------------------------------------------------------------------------- |
| `user_id` | string | 字符串，交易账号，输入； |
| `password` | string | 字符串，交易密码，输入； |
| `end_t` | datetime | 实数，查询日期，输入； |
| `order_id` | string | 字符串，母订单号，输入；（要查询所有委托母订单和执行状态时候，此参数可设置为空。否则，设置为启动策略成功后，返回的） |
| `query_type` | any | 整数，查询类型，输入； |
| `time_out` | any | 整数，超时时间（单位毫秒），输入； |
返回：array
### `tsAtStart(h, time_out, err_str)`
启动指定策略
| 参数 | 类型 | 说明 |
| ---------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `h` | any | 整数，交易客户登录成功返回后返回的交易句柄，输入；；Data:数组，要执行算法交易的策略和策略参数。根据要执行算法交易策略的不同，此参数的数值可能不同。输入； |
| `time_out` | any | 整数，超时时间（单位毫秒），输入； |
| `err_str` | string | 字符串，错误信息，输出； |
返回：string
### `tsAtStop(h, order_id, time_out)`
按照订单号停止指定策略
| 参数 | 类型 | 说明 |
| ---------- | ------ | -------------------------------------------------- |
| `h` | any | 整数，交易客户登录成功返回后返回的交易句柄，输入； |
| `order_id` | string | 启动策略成功后，返回的交易母单订单号，输入； |
| `time_out` | any | 整数，超时时间（单位毫秒），输入； |
返回：any
### `tsOrderFuturePosition(addr, broker_id, account, password, stkid, position, cancel_threshold, comment)`
函数会自动维护指定品种的头寸。用户不需要进行复杂的事务处理、交易下单、交易撤单等，大大简化了应用开发。 委托价格是品种的当前价格。当委托价格偏离最新价格指定阀值（cancel_threshold）时撤单；cancel_threshold< 0 不撤单（禁用撤单功能） 服务器模式：每间隔指定时间（循环中），调用行情信号模块——计算当前头寸，同时调用本指令维护头寸。 客户端模式：每间隔指定时间（循环中），调用行情信号模块——计算当前头寸，同时使用RDO2调用本指令维护头寸(交易在客户端)。
| 参数 | 类型 | 说明 |
| ------------------ | ------ | ------------------------------------------------------------------------ |
| `addr` | string | 字符串，期货交易柜台地址，输入； |
| `broker_id` | string | 字符串，经济公司代码，输入； |
| `account` | string | 字符串，交易账号，输入； |
| `password` | string | 字符串，交易密码，输入； |
| `stkid` | string | 字符串，代码，输入； |
| `position` | any | 整数，目标头寸，输入； |
| `cancel_threshold` | float | 实数，撤单阀值，输入； |
| `comment` | string | 字符串，说明信息，输入；（可以为每笔操作添加描述信息，以便区分每笔交易） |
返回：any
### `tsOrderFuturePositionCep(addr, broker_id, account, password, stkid, position, cancel_threshold, comment, act)`
本函数是对TSOrder_FuturePosition进行CEP封装，会每间隔1秒调用一次。 本指令每间隔1秒调用TSOrder_FuturePosition检查、维护指定品种头寸；运行参数为最后一次调用本函数（act=1设置头寸）的参数表。 服务器模式：本指令需要天软CEP（复杂事务处理）支持。可以订购指定品种行情事件、Timer事件，每当行情变动或定时器事件时，调用行情信号模块——计算当前头寸，同时调用本指令维护头寸。 客户端模式：天软客户端集成CEP(复杂事务处理),本指令可以通过RDO2推送到客户端运行。可以订购Timer事件（目前客户端暂不支持实时行情事件），每当定时器事件时，调用本指令维护头寸。
| 参数 | 类型 | 说明 |
| ------------------ | ------ | ---------------------------------------------------------------------------------------------------------------------- |
| `addr` | string | 字符串，期货交易柜台地址，输入； |
| `broker_id` | string | 字符串，经济公司代码，输入； |
| `account` | string | 字符串，交易账号，输入； |
| `password` | string | 字符串，交易密码，输入； |
| `stkid` | string | 字符串，代码，输入； |
| `position` | any | 整数，目标头寸，输入； |
| `cancel_threshold` | float | 实数，撤单阀值，输入； |
| `comment` | string | 字符串，说明信息，输入；（可以为每笔操作添加描述信息，以便区分每笔交易） |
| `act` | any | 整数，执行动作，输入；（1--设置当前头寸，-1--停止指令，2--查看指令运行情况，3--查看指令调用日志，4--查看当前头寸信息） |
返回：any
docs/tsl/codegen/dotnet/trading/index.md
+10
View File
@@ -0,0 +1,10 @@
# 算法交易
函数数：44
| 叶子 | 文件 | 函数数 |
| --- | --- | ---: |
| 算法交易 / 交易指令扩展及算法交易 | [算法交易 / 交易指令扩展及算法交易](algo_trade.md) | 7 |
| 算法交易 / 算法交易服务器支撑事件函数 | [算法交易 / 算法交易服务器支撑事件函数](server_events.md) | 10 |
| 算法交易 / 交易指令 | [算法交易 / 交易指令](trade_command.md) | 5 |
| 算法交易 / TSOrder2 | [算法交易 / TSOrder2](tsorder2.md) | 22 |
docs/tsl/codegen/dotnet/trading/server_events.md
+106
View File
@@ -0,0 +1,106 @@
# 算法交易 / 算法交易服务器支撑事件函数
### `addEvent(msg_type, msg_identy, code, id_list, user_id)`
订购消息。
| 参数 | 类型 | 说明 |
| ------------ | ------ | ------------------------------------------------------------------------ |
| `msg_type` | string | 字符串类型，可自定义的消息类别。 |
| `msg_identy` | string | 字符串类型。本次订购的标识，必需唯一。该标识会被用于取消订购等函数。 |
| `code` | string | 字符串类型，消息回调执行的一段代码。例如”EventCallBackSample(1);” |
| `id_list` | array | 订购的ID列表。例如订购多个行情更新消息，可采用ID列表代表更新的股票代码。 |
| `user_id` | string | 执行代码的时候所用函数所处的用户。 |
返回：any
### `getGlobalData(name)`
取全局数据。
| 参数 | 类型 | 说明 |
| ------ | ------ | ------------------------ |
| `name` | string | 字符串，全局数据的名称。 |
返回：any
### `listEvents()`
获得当前设置的事件信息表。
返回：array
### `listGlobalData()`
获得当前的全局数据信息列表。
返回：array
### `removeEvent(msg_identy)`
取消消息钩子。
| 参数 | 类型 | 说明 |
| ------------ | ------ | ---------------------------------- |
| `msg_identy` | string | 字符串类型，要取消的消息订购标识。 |
返回：any
### `removeGlobalData(name)`
删除全局数据。
| 参数 | 类型 | 说明 |
| ------ | ------ | ------------------------ |
| `name` | string | 字符串，全局数据的名称。 |
返回：bool
### `scheduleEvent(call_out_time, identy, code, user_id)`
调度事件。 备注:TimerEvent与ScheduleEvent的差异的ScheduleEvent只做一次，做完会自动取消，而TimerEvent则会不断间隔做。
| 参数 | 类型 | 说明 |
| --------------- | -------- | -------------------------------------------------------------------- |
| `call_out_time` | datetime | 整数，毫秒数，指定的毫秒数之后运行指定代码。 |
| `identy` | string | 字符串类型。本次订购的标识，必需唯一。该标识会被用于取消订购等函数。 |
| `code` | string | 字符串类型，消息回调执行的一段代码。例如”EventCallBackSample(1);” |
| `user_id` | string | 执行代码的时候所用函数所处的用户。 |
返回：any
### `sendEvent(msg_type, id_list, value)`
给消息队列发送事件，如果成功则返回真。
| 参数 | 类型 | 说明 |
| ---------- | ------ | -------------------------------------------------------------------- |
| `msg_type` | string | 字符串类型，可自定义的消息类别。 |
| `id_list` | array | 发送的ID列表。例如多个行情更新消息，可采用ID列表代表更新的股票代码。 |
| `value` | any | 发送的消息内容，任意类型。 |
返回：bool
### `setGlobalData(name, value)`
设置全局数据。
| 参数 | 类型 | 说明 |
| ------- | ------ | ------------------------ |
| `name` | string | 字符串，全局数据的名称。 |
| `value` | any | 全局数据的内容。 |
返回：array
### `timerEvent(call_out_time, identy, code, user_id)`
定时器事件。 备注:TimerEvent与ScheduleEvent的差异的ScheduleEvent只做一次，做完会自动取消，而TimerEvent则会不断间隔做。
| 参数 | 类型 | 说明 |
| --------------- | -------- | -------------------------------------------------------------------- |
| `call_out_time` | datetime | 整数，毫秒数，指定的毫秒数间隔不断运行指定代码。 |
| `identy` | string | 字符串类型。本次订购的标识，必需唯一。该标识会被用于取消订购等函数。 |
| `code` | string | 字符串类型，消息回调执行的一段代码。例如”EventCallBackSample(1);” |
| `user_id` | string | 执行代码的时候所用函数所处的用户。 |
返回：any
docs/tsl/codegen/dotnet/trading/trade_command.md
+72
View File
@@ -0,0 +1,72 @@
# 算法交易 / 交易指令
### `ttCancelWt(h, entrust_id, batch_flag, timeout, comment, _async)`
撤单接口。
| 参数 | 类型 | 说明 |
| ------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `h` | any | 整数，交易客户登入成功返回的句柄，输入； |
| `entrust_id` | string | 字符串，委托号或委托批号，输入；；（说明:以具体的柜台约定为准；1、单笔撤单，当输入的是委托号时，BatchFlag必须为0；；2、多笔撤单，输入必须是委托号，用\\ |
| `batch_flag` | any | 整数，委托批号，输入；；（描述EntrustID参数输入的是委托号或委托批号。0-委托号，1-委托批号。以具体的柜台约定为准） |
| `timeout` | any | 整数，超时（单位毫秒），输入； |
| `comment` | string | 字符串，可选参数，说明信息，输入；（可以为每笔操作添加描述信息，以便区分每笔交易） |
| `_async` | any | 整数，可选参数，委托模式，输入；（0--同步模式、1--异步模式） |
返回：array
### `ttMultiWt(h, order_str, batch_no, timeout)`
批量委托接口。
| 参数 | 类型 | 说明 |
| ----------- | ------ | ---------------------------------------------------------------------------------------------------- |
| `h` | any | 整数，交易客户登入成功返回的句柄，输入； |
| `order_str` | string | 字符串，批量委托串输入；；具体格式为:两笔委托间用分号;隔开。一笔委托用\\ |
| `batch_no` | string | 字符串，委托批号，输入；；以具体柜台接口约定为准，当委托成功后，我们可以用此批号查询、撤单本次委托。 |
| `timeout` | any | 整数，超时（单位毫秒），输入 |
返回：array
### `ttUserLogin(gate_way, account_type, account_id, account_pwd, timeout, errmsg)`
交易账户登入接口。
| 参数 | 类型 | 说明 |
| -------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------- |
| `gate_way` | string | 字符串，网关支持的柜台接口名称，输入；（:如xxx证券、XXX期货、AAA证券恒生柜台等。） |
| `account_type` | string | 字符串，账号属性，输入；（输入柜台地址、资金账号、股东卡号、牛卡号等。如果是CTP账号则输入柜台地址，如果是天软模拟柜台输入为空） |
| `account_id` | string | 字符串，交易账号，输入； |
| `account_pwd` | string | 字符串，交易密码，输入 |
| `timeout` | any | 整数，超时（单位毫秒），输入 |
| `errmsg` | string | 字符串，登陆错误信息，输出值 |
返回：any
### `ttUserLogout(h, timeout)`
交易账户注销接口。
| 参数 | 类型 | 说明 |
| --------- | ---- | ---------------------------------------- |
| `h` | any | 整数，交易客户登入成功返回的句柄，输入； |
| `timeout` | any | 整数，超时（单位毫秒），输入 |
返回：array
### `ttWt(h, bs, stk_id, price, vol, timeout, comment, _async)`
委托接口。
| 参数 | 类型 | 说明 |
| --------- | ------ | ---------------------------------------------------------------------------------- |
| `h` | any | 整数，交易客户登入成功返回的句柄，输入； |
| `bs` | string | 字符串，委托属性，输入；指令如下: |
| `stk_id` | string | 字符串，股票代码，输入；（如SH600000,SZ000002,IF1109） |
| `price` | float | 实数，委托价格价格，输入； |
| `vol` | any | 整数，委托数量，输入； |
| `timeout` | any | 整数，超时（单位毫秒），输入； |
| `comment` | string | 字符串，可选参数，说明信息，输入；（可以为每笔操作添加描述信息，以便区分每笔交易） |
| `_async` | any | 整数，可选参数，委托模式，输入；（0--同步模式、1--异步模式） |
返回：array
docs/tsl/codegen/dotnet/trading/tsorder2.md
+204
View File
@@ -0,0 +1,204 @@
# 算法交易 / TSOrder2
### `addLog(msg)`
订单日志功能。
| 参数 | 类型 | 说明 |
| ----- | ------ | ---- |
| `msg` | string | 信息 |
返回：any
### `cancelOrder(entrust_id)`
撤单指定的子单。
| 参数 | 类型 | 说明 |
| ------------ | ------ | ---------- |
| `entrust_id` | string | 子单撤单号 |
返回：any
### `cancelOrder1()`
子单撤单指令1（根据预设的参数：argv\[‘撤单时间’\],argv\[‘价格撤单模式’\]等，撤掉所有符合条件的订单）
返回：any
### `cancelOrder2()`
子单撤单指令2（撤掉所有可撤的子单）
返回：any
### `create(url, header, onmessage, u, p, s, reconn)`
构造方法
| 参数 | 类型 | 说明 |
| ----------- | ------ | --------------------------------------------------------------- |
| `url` | string | TS-OPS服务注册地址 |
| `header` | string | TS-OPS服务注册时需要指定的头部信息，比如TS-OPS-CALL等 |
| `onmessage` | any | 消息处理过程，指向一个函数。可通过Findfunction("函数名")产生 |
| `u` | string | 用户名 |
| `p` | string | 用户密码 |
| `s` | string | 租户Session Key；使用特殊租户（调用功能列表为\*）替代用户时指定 |
| `reconn` | bool | object |
返回：any
### `doOrder()`
虚方法，用户重载此方法，当指定品种行情到达、或定时器触发消息，会回调此函数，用户在此函数中下单、撤单或结束订单。
返回：any
### `getCdprice()`
获得撤单价格（根据预设的参数：argv\[‘代码’\],argv\[‘交易方向’\],argv\[‘价格撤单-买卖盘参考档’\]等参数，获得撤单价格）
返回：float
### `getData()`
返回用户创建订单的参数表
返回：array
### `getKey(key)`
获得订单个性化数据key的值
| 参数 | 类型 | 说明 |
| ----- | ------ | ---- |
| `key` | string | 键 |
返回：any
### `getOid()`
返回订单号
返回：string
### `getOrders(o_type)`
获取所有子单信息
| 参数 | 类型 | 说明 |
| -------- | ---- | -------- |
| `o_type` | int | 类型如下 |
返回：array
### `getPkVol(bs, n)`
获得股票盘口数量（根据交易方向和行情档获得行情档下的盘口数量，如方向为”B”,行情档为二，则股票盘口数量为卖一量+卖二量）
| 参数 | 类型 | 说明 |
| ---- | ------ | ------------------- |
| `bs` | string | 交易方向（”B”,”S”） |
| `n` | any | 行情档 |
返回：any
### `getPrice()`
获得交易价格（系统根据预设的参数：argv\[‘代码’\],argv\[‘交易方向’\], argv\['委托价类别'\]等自动计算委托价）。
返回：float
### `getValue(d_type, v1, v2)`
获取当前订单的状态信息。
| 参数 | 类型 | 说明 |
| -------- | -------- | ----------------------------- |
| `d_type` | int | 类型如下 |
| `v1` | datetime | 当dType=2时，统计的开始时间。 |
| `v2` | datetime | 当dType=2时，统计的结束时间 |
返回：string
### `init()`
虚方法，订单被创建时调用此方法，用户重载此方法可以做相关订单初始化工作。
返回：any
### `isInit()`
订单是否初始化成功
返回：bool
### `release(msg)`
结束订单。
| 参数 | 类型 | 说明 |
| ----- | ------ | ------------------------ |
| `msg` | string | 字符串，结束订单备注信息 |
返回：any
### `setKey(key, val)`
存贮订单个性化数据key-value
| 参数 | 类型 | 说明 |
| ----- | ------ | -------------- |
| `key` | string | 键 |
| `val` | any | any,存储的数据 |
返回：any
### `sysLog(oid, msg)`
将日志输出到系统日志中
| 参数 | 类型 | 说明 |
| ----- | ------ | ------ |
| `oid` | any | 订单号 |
| `msg` | string | 信息 |
返回：any
### `tOrder(bs, price, v, comment)`
子单委托指令
| 参数 | 类型 | 说明 |
| --------- | ------ | ------------ |
| `bs` | string | 买卖方向(B\\ |
| `price` | float | 买卖价格 |
| `v` | float | 买卖数量 |
| `comment` | string | 备注信息 |
返回：any
### `tOrder2(stkid, bs, price, v, comment)`
子单委托指令2（对于篮子订单，可以委托不同的股票及买卖方向）
| 参数 | 类型 | 说明 |
| --------- | ------ | ------------ |
| `stkid` | string | 股票代码 |
| `bs` | string | 买卖方向(B\\ |
| `price` | float | 买卖价格 |
| `v` | float | 买卖数量 |
| `comment` | string | 备注信息 |
返回：any
### `tOrder3(v, comment)`
子单委托指令3（系统根据预设的参数自动获取买卖方向，买卖价格）
| 参数 | 类型 | 说明 |
| --------- | ------ | -------- |
| `v` | float | 买卖数量 |
| `comment` | string | 备注信息 |
返回：any