命令说明
命令按域组织。如果要在 lgrConfig.xml 中添加命令,必须指定其所属的域。这些域包括:
- System
- Player
- Recorder
- Editor
- Simulation
- Invalid
在配置文件中使用时,Simulation 域命令需要一个协议字符串。有效的协议字符串为:
- None
- HLA 13
- HLA 1516
参数类型
许多命令都有参数。为参数输入的数据必须是正确的类型。例如,如果某个参数接受 int(整数),值 5 可以接受,但 5.0 不行。在命令说明中,命令参数类型显示在每个参数之后的括号中。表 43 说明了命令所使用的参数类型。
表 43:参数类型
| 参数类型 | 说明 |
|---|---|
| int | 32 位有符号整数。例如:SetNotifyLevel 2 |
| int64 | 64 位有符号整数。例如:SetStepSize 1000000 |
| double | 64 位浮点数。例如:SetTimeoutRate 5.0 |
| stringlist | 一系列以空格分隔的字符串。各个字符串中不能包含空格。整个序列用双引号括起来。例如:"string1 string2 string3" |
| string | 由字母数字字符组成的字符串。 |
| time | 时间值可以以 double(以秒为单位)或 时:分:秒:秒的小数部分 格式输入。 |
| base64 | 以 base 64 字符串编码的二进制数据。 |
| bool | 布尔值。可以为 true、false、1(true)或 0(false)。 |
System 域命令
表 44 说明了 System 域中的命令。
表 44:System 域命令
| 命令 | 说明 |
|---|---|
DeleteFile filename(string) |
删除指定文件。此命令被认为是危险命令,应谨慎使用。 |
Exit |
关闭 Logger。 |
Help |
显示可用命令列表。 |
LoadPlugin pluginName(string) |
加载指定插件。 |
SetEntityTracking |
允许处理实体跟踪。默认启用。禁用时,不允许处理实体跟踪,且实体过滤器为空。 |
SetFastJumpsWithoutDiff |
跳转时,使用检查点来确定对象的相对状态,但不处理检查点与跳转时间之间的数据包。 |
SetNotifyLevel vlLevel(int) lgrLevel(int) |
设置 VR-Link 和 Logger 的通知级别。 |
SetPlaybackReadTimeLimit |
当大于 0.0 时,此命令限制 Logger 在回放期间从 Logger 文件读取数据包所花费的时间,超过该时间后,直到当前时间为止的剩余数据包将被丢弃。 |
SetTempDir directory(string) |
设置 Logger 在记录和编辑时存储临时 Logger 文件的目录。默认情况下,Logger 使用当前用户的 temp 目录(因操作系统而异)。如果指定临时目录,出于性能考虑最好使用本地目录。要将 temp 目录重置为系统目录,请使用空字符串。Logger 会在不再需要时删除临时文件。 |
Player 域命令
表 45 说明了 Player 域中的命令。
表 45:Player 域命令
| 命令 | 说明 |
|---|---|
ClosePlaybackFile |
关闭当前回放文件。 |
OpenFile filename(string) |
打开指定文件进行回放。 |
Pause |
暂停回放。如果 Logger 没有打开文件或者已经处于暂停状态,此命令没有效果。 |
Play |
开始回放。如果 Logger 已经在播放,此命令没有效果。 |
PlayPause |
在暂停和播放状态之间切换。如果 Logger 已停止,则开始回放。 |
Restart |
从文件开头开始播放。 |
RevertFile |
将先前已保存但当前未保存的文件恢复到先前保存的状态。自上次保存以来的所有更改都会丢失。此命令仅适用于为回放或编辑而打开的文件。 |
SaveFile |
将先前已保存但当前未保存的文件保存到其当前文件名。之前的文件会备份为名为 filename.bak.lgr 的文件,例如:test.lgr 将被保存到 test.bak.lgr。当前文件包含最新的更改。 |
SaveFileAs filename(string) |
将当前文件保存到新文件。 |
SetBackupOnSave backup(bool) |
启用或禁用保存先前已保存文件时的自动备份。 |
SetCurrentTime time(time) |
将时间线光标移动到指定时间。 |
SetLoopAtEnd value(bool) |
启用或禁用回放到结尾时的循环。 |
SetPlaybackSpeed speed(double) |
设置 Logger 的回放速度。 |
SetPlayOnLoad value(bool) |
启用打开文件后立即开始回放。 |
SetStartStopTimes startTime(time) stopTime(time) |
设置 Logger 的开始和停止时间。这两个时间绑定到磁带中的第一个和最后一个时间。停止时间必须晚于开始时间。 |
StopPlayback |
停止回放。如果 Logger 不处于回放状态,此命令没有效果。 |
Unpause |
取消 Logger 的暂停。如果 Logger 未处于暂停状态,此命令没有效果。 |
Recorder 域命令
表 46 说明了 Recorder 域中的命令。
表 46:Recorder 域命令
| 命令 | 说明 |
|---|---|
CancelRecording |
取消当前记录。Logger 必须当前正在记录。命令执行后,Logger 处于空状态,没有加载文件。 |
CloseRecordFile |
关闭当前正在记录的文件。 |
NewFile filename(string) overwrite(bool) |
打开新文件进行记录。 |
PauseRecording |
暂停记录过程。记录停止,但数据不会保存,Logger 仍处于记录模式。Logger 暂停期间不记录任何数据。可以在同一文件中恢复记录。 |
Record |
开始记录到新文件。 |
SetCheckpointParameters policy(int) size(int) count(int) time(time) |
设置关于何时生成检查点的检查点策略参数。Policy 为以下之一: - 0 — 数量,以数据包数计 - 1 — 数据包大小,以字节计 - 2 — 时间,以检查点之间的秒数计。 **注:**必须在命令行上为每个参数指定一个值。对于未使用的策略,该值不必有意义。 |
SetPauseOnRecordAs record(bool) |
决定 Logger 在收到 Record As 命令时的行为。如果为 true,Logger 会暂停,直到收到 Record 命令才开始记录。如果为 false,Logger 在指定文件名后立即开始记录。 |
SetStopCondition condition(int) close (bool) |
按如下方式指定记录的停止条件: - 0 — 无条件 - 1 — 持续时间(启用 SetStopDuration) - 2 — 文件大小(启用 SetStopSize)。 如果 close 参数为 True,则在记录停止时关闭文件。 |
SetStopDuration duration(time) |
如果 SetStopCondition 设置为 1,则在指定时间停止记录。 |
SetStopSize filesize(int64) |
如果 SetStopCondition 设置为 2,则当文件达到 filesize 大小时停止记录。 |
StopRecording closeAndOpenForPlayback(bool) |
停止记录并结束。默认情况下 closeAndOpenForPlayback 为 true (1)。如果将 closeAndOpenForPlayback 设置为 false (0),则在发出 StopRecording 后,仍处于记录模式。需要发出 CloseRecordFile 命令来关闭文件并退出记录模式。 |
Simulation 域命令
表 47 说明了 Simulation 域。SetConnectionParameters 命令的使用示例见各协议专用的配置文件。有关参数的完整定义,请参阅“为 3DNV 配置 Multi-Federate Logger“(第 385 页)。
表 47:Simulation 域命令
| 命令 | 说明 |
|---|---|
| 与协议无关的命令 | |
Connect |
使用先前设置的参数连接到网络仿真。 |
Disconnect |
与网络仿真断开连接。 |
SetRemoteControlId remoteControlId (integer) |
指定 Logger 的远程控制 ID。默认情况下,该值被赋予 Logger 的站点 ID。当 SetRemoteControlSettings 的 allowAllRemoteControl 被禁用时,将使用此值。 |
SetRemoteControlSettings process(bool) record(bool) allowDelete(bool) allowAllRemoteControl(bool) |
指定 Logger 如何响应 Logger Control 消息。 - process 参数决定 Logger 是否响应 Logger 控制消息。 - record 参数决定 Logger 控制消息是否包含在文件中。 - allowDelete 参数决定是否响应删除文件的 Logger 控制消息。 - allowAllRemoteControl 决定是否根据 Logger 的 site-application-entityNum 三元组过滤远程控制 PDU,其中 Logger 的远程控制 ID 用于 enityNum。默认情况下此参数已启用,所有远程控制 PDU 都被接受。禁用时,当接收者 ID 与 Logger 匹配时,Logger 接受远程控制 PDU。接收者 ID 可以在三元组的任意值中使用通配值(0xFFFF 或无符号整数 = 65535)(例如,1:1:65535 匹配站点 = 1 且应用 ID = 1 的任意 Logger)。不匹配的远程控制 PDU 会被过滤。默认情况下,Logger 的远程控制 ID 等于其站点 ID。可以使用 SetRemoteControlId 命令更改远程控制 ID。**注:**allowAllRemoteControl 参数必须始终指定,但仅在 DIS 中使用。 |
SetScaleAttributes scale(bool) |
启用或禁用由于回放速度变化引起的属性缩放。启用时,属性(如速度和加速度)会被缩放以与回放速度变化同步。禁用时不发生缩放。 |
SetVRFFiltering filter(bool) loId(int) hiId(int) |
配置 VR-Forces 消息过滤。filter 参数启用或禁用 VR-Forces 消息的过滤。loId 参数指定要过滤掉的最低消息 ID。hiId 参数指定要过滤掉的最高消息 ID。 |
| HLA 专用命令 | |
LoadSubscriptionListFile filename(string) |
加载订阅列表文件。订阅列表文件是使用 Logger GUI 创建的 XML 文件。Logger 必须处于连接状态。订阅设置从文件中加载。 |
SaveSubscriptionListFile filename(string) |
将订阅设置保存到指定名称的 XML 文件。在 GUI 中,扩展名 .subx 会添加到文件名,但从命令行保存时不会添加到文件名。 |
SetConnectionParameters federateName(string) federateType(string) federationName(string) fedFile(string) fomModules(stringList) MIM(string) ignoreAdvisories(bool) fomVersion(string) fomRevision(int) fomMapper(string) fomMapperData(string) useEmptyFomMapper(bool) |
**注:**federateType、fomModules 和 MIM 参数仅适用于 HLA Evolved。 指定 HLA 连接参数: - federateName。Logger 联邦成员的名称 - federateType。Logger 联邦成员的类型。(仅 HLA Evolved) - federationName。联邦执行的名称 - fedFile。FED 文件(或 FDD 或 XML 文件)的名称 - fomModules。一个或多个 FOM 模块文件。(仅 HLA Evolved) - MIM。一个 MIM 文件。(仅 HLA Evolved) - ignoreAdvisories。配置 Logger 忽略 RTI 建议队列并始终发送数据。(仅 HLA Evolved) - fomVersion。所使用的 RPR FOM 版本 - fomRevision。版本 2.0017 所使用的 RPR FOM 修订版。(1、2 或 3) - fomMapper。所使用的 FOM Mapper 的名称(如果有) - fomMapperData。FOM Mapper 的初始化数据(如果需要)。 - useEmptyFomMapper。Logger 将使用空的 FOM Mapper,使其能够使用任意 FOM 进行记录和回放。空的 FOM Mapper 不支持某些回放功能,例如暂停或缩放,这些功能要求 Logger 使用航位推算(dead reckoning)来生成中间更新。 |
SetDdmParameters enableDdm(bool) playbackMode(string) subscribeMode(string) |
指定 DDM 参数,如下: - enableDdm。启用使用 DDM 的记录与回放。默认:false。 - playbackMode。支持的模式有: — PlaybackRegionsUseConveyedExtents。回放期间,使用记录的区域数据创建和更新区域。— PlaybackRegionsUseData。通过检查仿真数据来创建和更新区域(。需要插件扩展。— PlaybackRegionNotEnabled(默认)。更新和交互在没有区域的情况下发送。- subscribeMode。支持的模式: — SubscribeRegionsAreGlobal。DDM 订阅使用具有全局最小和最大范围的全局区域进行。— SubscribeRegionsAreSpecified。区域通过订阅配置文件指定。(有关详细信息,请参阅 LoadSubscriptionListFile 命令。)— SubscribeRegionNotEnabled(默认)。订阅在没有区域的情况下执行。 |
SetDdmParameters playbackDynamicAssociation(bool) playbackDynamicExtents(bool) allowPlaybackWithoutRegions(bool) recordConveyedRegions(bool) requestUpdates(bool) subscribeUnspecifiedAttributes(bool) |
参数(续): - playbackDynamicAssociation。回放期间,区域与对象实例属性的关联可以是固定的或动态的。如果已知区域与属性实例的关联从不变化,可以消除检查变化的开销。如果可能,应禁用此参数。默认:false。 - playbackDynamicExtents。回放期间,区域范围可以是固定的或动态的。DDM 区域的传统观念将其视为动态变化的范围,以反映仿真数据的状态(例如,围绕实体的位置)。另一种方法是区域固定,而对象属性实例在区域之间移动。如果已知区域范围从不变化,可以消除检查变化的开销。如果可能,应禁用此参数。默认:false。 - allowPlaybackWithoutRegions。回放期间,可能无法建立区域关联。在这些情况下,Logger 在没有区域关联的情况下发送数据。如果联邦协议要求所有数据必须与关联区域一起传输,请禁用此参数。默认:true。 - recordConveyedRegions。启用此参数以记录 conveyed 区域。默认:true。 - requestUpdates。请求更新可能导致网络流量激增,尤其是在演习中已经存在大量对象时由后加入的联邦成员执行请求的情况下。在某些 DDM 联邦中,使用对象心跳代替更新请求。禁用此参数以防止 Logger 发出更新请求。 - subscribeUnspecifiedAttributes。Logger 可能无法确定要应用于交互类或对象类属性订阅的区域关联。如果交互或类在 FOM 中未指定路由空间或维度,可能出现这种情况。如果 subscribeMode 配置为 SubscribeRegionsAreSpecified,但某些类或属性未指定,也可能发生这种情况。默认情况下,Logger 在不使用区域关联的情况下订阅这些交互类和对象类属性(实际上是全局订阅)。如果 Logger 只应在可以使用区域关联时才订阅,请禁用此参数。默认:true。 |
SetDisableTimeManagementTest disableTesting(bool) |
如果 Time Management 测试导致 Logger 行为异常,则禁用该测试。通常,当启用时间管理(Time Management)时,Logger 连接时会尝试成为受时间约束的联邦成员,以查看 RTI 中是否启用了时间管理。如果成功,Logger 按用户配置设置时间管理设置。在某些情况下,此测试会导致 Logger 挂起。如果出现此问题,将 disableTesting 设置为 true 可关闭该测试。但时间管理功能将被禁用。 |
SetDrainInput(double maxTime, double minTime) |
指定每个 tick 从演习连接(即网络)读取消息所花费的最小和最大时间(以秒为单位)。 |
SetDynamicNamePrefix prefix(string) |
指定 Logger 在记录演习时附加到以 HLA_ 开头的对象名称前面的前缀。 |
SetHeartbeatIntervals "className(string):interval(float):inheritable(bool) ..." |
指定回放的心跳间隔。可以指定多个类。有关详细信息,请参阅“配置 HLA 心跳“(第 390 页)。 |
SetIgnoreAdvisories ignore(bool) |
指定 Logger 对 HLA 建议消息的响应。必须在 connect 命令之前指定此命令。默认:false。 |
SetPassiveSubscription passive(bool) |
为 HLA 配置被动订阅。必须在 connect 命令之前指定此命令。默认:false。 |
SetSubscriptionLists objectClasses(stringList) interactionClasses(stringList) |
设置类订阅列表。要订阅某个类,该类必须在列表中。每个类必须使用完整的 HLA 类名(包括父类)指定。某些操作系统的命令行缓冲区不够长,无法在命令行上使用此命令。Logger 必须处于连接状态。更新后的订阅列表在下次记录时生效。 |
SetTimeManagement timeConstrainedPlayback(bool) timeRegulatingRecording(bool) |
配置时间管理选项。timeConstrainedPlayback 和 timeRegulatingRecording 参数必须包含在命令行上,但不受支持且会被忽略。 |
SetTimeoutIntervals "className(string):interval(float):inheritable(bool) ..." |
指定记录的对象超时。可以指定多个类。有关详细信息,请参阅“配置 HLA 超时“(第 390 页)。 |
Editor 域命令
表 48 说明了 Editor 域中的命令。
**注:**编辑操作只能对已为回放而打开的文件执行。执行编辑后,编辑过的文件处于未保存状态。必须保存它才能保留更改。
表 48:Editor 域命令
| 命令 | 说明 |
|---|---|
AppendFileToEnd filename(string) |
将文件 filename 追加到打开文件的末尾。 |
ClearSection start(time) end(time) |
删除文件中 start 和 end 时间之间的所有数据包。 |
ConvertFile |
将当前文件转换为最新的文件格式。此命令对已经处于最新格式的文件无效。 |
CutSection start(time) end(time) |
删除文件中 start 和 end 时间之间的所有数据包。end 时间之后的所有数据包都会被偏移,使 end 时间之后的第一个数据包位于 start 时间。 |
ExportFile destination(string) exportFormat(string) checkpoint(bool) openAfterExport(bool) |
使用给定的 exportFormat 将文件导出到 destination。最后两个参数仅在导出 Logger 文件时使用。Logger 尝试使用 exportFormat 和 destination 进行导出。如果 checkpoint 为 true 且文件是 Logger 文件,则为输出生成新的检查点。 如果 openAfterExport 为 true 且文件是 Logger 文件,Logger 会关闭当前文件并尝试打开新文件。 有效的 exportFormat 字符串基于已注册的导出对象。有效的字符串与 GUI 中的 Export 和 Export Selection 菜单命令相同。Logger 自带的格式有 Plain Text(如果加载了 lgrDump 插件)和 Logger File(导出为 Logger 文件)。 destination 通常是文件名(但不必如此),并且特定于 exportFormat。Plain Text 导出器导出到任意文件名,但通常导出为 .txt 文件。Logger File 导出器导出到 .lgr 文件,如果 destination 字符串中没有该扩展名则添加它。其他导出器可能以不同方式编码 destination。 |
ExportSection start(time) end(time) destination(string) exportFormat(string) |
使用给定的 exportFormat 将文件的一部分导出到 destination。此命令的工作方式与 ExportFile 命令完全相同,只是导出文件的一段而不是整个文件。 |
MergeInFile filename(string) offset(time) |
将 Logger 文件 filename 合并到打开的文件中。可选的偏移会应用于该文件的所有数据包,然后再与当前数据合并。 |
OffsetTime offset(time) |
将打开文件中数据包的时间偏移 offset 值。offset 值可以是正数或负数。但是,如果指定负偏移,任何结果时间小于零的数据都会丢失。 |
PrefixFileToStart filename(string) |
将名为 filename 的文件插入到打开文件的开头。 |
TrimStart |
删除文件开头的任何空闲时间,并偏移所有数据包,使第一个数据包的时间戳为 0.0。 |