Command Descriptions

Commands are organized into domains. If you add a command to lgrConfig.xml, you must specify the domain. The domains are:

  • System
  • Player
  • Recorder
  • Editor
  • Simulation
  • Invalid

When used in the configuration file, simulation domain commands require a protocol string. The valid protocol strings are:

  • None
  • HLA 13
  • HLA 1516

Argument Types

Many commands have arguments. The data you enter for arguments must be of the correct type. For example, if an argument takes an int (integer), the value 5 is acceptable, but 5.0 is not. In the command descriptions, command argument types are shown in parentheses following each argument. Table 43 describes the argument types used for commands.

Table 43: Argument types

Argument Type Description
int 32 bit signed integer. For example:
SetNotifyLevel 2
int64 64 bit signed integer. For example:
SetStepSize 1000000
double 64 bit floating point number. For example:
SetTimeoutRate 5.0
stringlist A series of strings, separated by spaces. The individual strings cannot have spaces. The entire series is surrounded by double quotes. For example:
"string1 string2 string3"
string A string of alphanumeric characters.
time Time values can be entered as a double (in seconds) or in Hour:Minute:Second:Fractions of a second format.
base64 Binary data encoded as a base 64 string.
bool Boolean value. Can be true, false, 1 (true), or 0 (false).

System Domain Commands

Table 44 describes the commands in the System domain.

Table 44: System domain commands

Command Description
DeleteFile filename(string) Deletes the specified file. This command is considered dangerous and should only be used with caution.
Exit Shuts down the Logger.
Help Displays a list of available commands.
LoadPlugin pluginName(string) Loads the specified plug-in.
SetEntityTracking Allows entity tracking to be processed. Enabled by default. When disabled, entity tracking is not allowed to be processed and the entity filter is empty.
SetFastJumpsWithoutDiff When jumping, checkpoints are used to establish the relative state of objects, but the packets between the checkpoint and jump time are not processed.
SetNotifyLevel vlLevel(int) lgrLevel(int) Sets the notification level of VR-Link and the Logger.
SetPlaybackReadTimeLimit When greater than 0.0, this command sets a limit on how long the Logger can spend reading packets from the Logger file during playback, after which the remaining packets up to the current time will be dropped.
SetTempDir directory(string) Sets the directory in which the Logger stores temporary Logger files when recording and editing. By default the Logger uses the current user's temp directory (OS specific). If you specify a temporary directory, it is best to use a local directory for performance reasons. To reset the temp directory to the system directory use an empty string. The Logger deletes the temporary files when they are no longer needed.

Player Domain Commands

Table 45 describes the commands in the Player domain.

Table 45: Player domain commands

Command Description
ClosePlaybackFile Closes the current playback file.
OpenFile filename(string) Opens the specified file for playback.
Pause Pauses playback. This command has no effect if the Logger does not have a file open or is already paused.
Play Starts playback. If the Logger is already playing this command has no effect.
PlayPause Toggles between the paused and play state. If the Logger is stopped, it starts playback.
Restart Starts playing from the beginning of the file.
RevertFile Reverts a previously saved, but currently unsaved file to the previously saved state. All changes since the last save are lost. This command applies only to files that you open for playback or editing.
SaveFile Saves a previously saved, but currently unsaved file to its current file name. The previous file is backed up to a file named filename.bak.lgr, for example: test.lgr would get saved to test.bak.lgr. The current file contains the latest changes.
SaveFileAs filename(string) Saves the current file to new file.
SetBackupOnSave backup(bool) Enables or disables automatic backup when you save a previously saved file.
SetCurrentTime time(time) Moves the timeline cursor to the specified time.
SetLoopAtEnd value(bool) Enables or disables looping to start at the end of playback.
SetPlaybackSpeed speed(double) Sets the playback speed of the Logger.
SetPlayOnLoad value(bool) Enables starting playback immediately after opening a file.
SetStartStopTimes startTime(time) stopTime(time) Sets the start and stop time of the Logger. The two times are bound to the first and last times in the tape. The stop time must be after the start time.
StopPlayback Stops playback. This command has no effect if the Logger is not in the playback state.
Unpause Unpauses the Logger. This command has no effect if the Logger is not paused.

Recorder Domain Commands

Table 46 describes the commands in the Recorder domain.

Table 46: Recorder domain commands

Command Description
CancelRecording Cancels the current recording. The Logger must be currently recording. After the command is executed, the Logger is in an empty state, no file is loaded.
CloseRecordFile Closes the file currently recording.
NewFile filename(string) overwrite(bool) Opens a new file for recording.
PauseRecording Pauses the recording process. Recording stops, but the data is not saved and the Logger remains in record mode. No data is recorded while the Logger is paused. You can resume recording to the same file.
Record Starts recording to a new file.
SetCheckpointParameters policy(int) size(int) count(int) time(time) Sets the checkpoint policy parameters on when checkpoints are generated. The Policy is one of the following:
- 0 — count, in number of packets
- 1 — size of packets, in bytes
- 2 — time, in seconds between checkpoints.
Note: You must specify a value for each argument on the command line. The value does not need to be meaningful for the policies that are not being used.
SetPauseOnRecordAs record(bool) Determines how the Logger behaves when given the Record As command. If true, the Logger pauses and does not begin recording until it is given the Record command. If false, the Logger begins recording as soon as a file name is specified.
SetStopCondition condition(int) close (bool) Specifies the stop condition for recording as follows:
- 0 — no condition
- 1 — duration (enables SetStopDuration)
- 2 — filesize (enables SetStopSize).
If the close parameter is True, the file is closed when recording is stopped.
SetStopDuration duration(time) Stops recording at the specified time if SetStopCondition is set to 1.
SetStopSize filesize(int64) Stops recording when the file reaches filesize size if SetStopCondition is set to 2.
StopRecording closeAndOpenForPlayback(bool) Stops recording and ends. By default closeAndOpenForPlayback is true (1). If you set closeAndOpenForPlayback to false (0), then after you issue StopRecording, you are still in record mode. You would need to issue the CloseRecordFile command to close the file and exit record mode.

Simulation Domain Commands

Table 47 describes the Simulation domain. Examples of using the SetConnectionParameters command are in the protocol-specific configuration files. For a full definition of the arguments, please see “Configuring Multi-Federate Logger for 3DNV“ on page 385.

Table 47: Simulation domain commands

Command Description
Protocol-independent Commands
Connect Connects to the network simulation using the previously set parameters.
Disconnect Disconnects from the network simulation.
SetRemoteControlId remoteControlId (integer) Specifies the Logger's remote control ID. By default the value is assigned the Logger's site ID. This value is used if SetRemoteControlSettings allowAllRemoteControl is disabled.
SetRemoteControlSettings process(bool) record(bool) allowDelete(bool) allowAllRemoteControl(bool) Specifies how the Logger responds to Logger Control messages.
- process argument determines whether the Logger responds to Logger control messages.
- record argument determines whether or not Logger control messages are included in the file.
- allowDelete argument determines whether or not to respond to the delete file Logger control message.
- allowAllRemoteControl determines whether remote control PDUs are filtered based on the Logger’s site-application-entityNum triplet, where the Logger’s remote control ID is used for the enityNum. By default this parameter is enabled and all remote control PDUs are accepted. When disabled, the Logger accepts remote control PDUs when the receiver ID matches the Logger. The receiver ID can have wildcard values (0xFFFF or unsigned int = 65535) in any of the triplet values (for example, 1:1:65535 matches any Logger with site = 1 and application ID = 1). Remote control PDUs are filtered when they do not match. By default, the Logger’s remote control ID equals its site ID. The remote control ID can be changed using the SetRemoteControlId command.
Note: The allowAllRemoteControl parameter must always be specified, but it is only used in DIS.
SetScaleAttributes scale(bool) Enables or disables attribute scaling due to changes in playback speed. When enabled, attributes (such as velocity and acceleration) are scaled to synchronize with playback speed changes. When disabled no scaling occurs.
SetVRFFiltering filter(bool) loId(int) hiId(int) Configures VR-Forces message filtering. The filter argument enables or disables filtering of VR-Forces messages. The loId argument specifies the lowest message ID to filter out. The hiId argument specifies the highest message ID to filter out.
HLA-specific Commands
LoadSubscriptionListFile filename(string) Loads a subscription list file. The subscription list file is an XML file that you create using the Logger GUI. The Logger must be connected. The subscription settings are loaded from the file.
SaveSubscriptionListFile filename(string) Saves the subscription settings to an XML file with the specified name. In the GUI, the extension .subx is added to filenames, but it is not added to the filename when saved from the command line.
SetConnectionParameters federateName(string) federateType(string) federationName(string) fedFile(string) fomModules(string) MIM(string) ignoreAdvisories(bool) fomVersion(double) fomRevision(int) fomMapper(string) fomMapperData(base64) useEmptyFomMapper(bool) Note: The federateType, fomModules, and MIM parameters apply only to HLA Evolved.
Specifies HLA connection parameters:
- federateName. The name of the Logger federate
- federateType. The type of the Logger federate. (HLA Evolved only)
- federationName. The name of the federation execution
- fedFile. The name of the FED file (or FDD or XML file)
- fomModules. One or more FOM module files. (HLA Evolved only)
- MIM. A MIM file. (HLA Evolved only)
- ignoreAdvisories. Configures the Logger to ignore RTI advisory queues and always send data. (HLA Evolved only)
- fomVersion. The RPR FOM version being used
- fomRevision. The RPR FOM revision being used for version 2.0017. (1, 2, or 3)
- fomMapper. The name of the FOM Mapper being used, if any
- fomMapperData. Initialization data for the FOM Mapper, if required.
- useEmptyFomMapper. The Logger will use an empty FOM Mapper, allowing it to record and playback using any FOM. The empty FOM Mapper does not support some playback features such as pause or scaling, which require the Logger to use dead reckoning to generate intermediate updates.
SetDdmParameters enableDdm(bool) playbackMode(string) subscribeMode(string) playbackDynamicAssociation(bool) playbackDynamicExtents(bool) allowPlaybackWithoutRegions(bool) recordConveyedRegions(bool) requestUpdates(bool) subscribeUnspecifiedAttributes(bool) Specifies DDM parameters, as follows:
- enableDdm. Enable record and playback using DDM. Default: false.
- playbackMode. Supported modes are:
—PlaybackRegionsUseConveyedExtents. During playback, regions are created and updated using recorded region data.
—PlaybackRegionsUseData. Regions are created and updated by inspecting simulation data (. Requires plug-in extension.
—PlaybackRegionNotEnabled (default). Updates and interactions are sent without regions.
- subscribeMode. Supported modes:
—SubscribeRegionsAreGlobal. DDM subscriptions are made with global regions with extents of global min and max.
—SubscribeRegionsAreSpecified. The regions are specified through subscription configuration files. (For details, please see the LoadSubscriptionListFile command.)
—SubscribeRegionNotEnabled (default). Subscriptions are performed without regions.
SetDdmParameters (continued) Parameters (continued):
- playbackDynamicAssociation. During playback, the association of regions with object instance attributes can be fixed or dynamic. If it is known that region associations with attribute instances never change, the overhead of checking for changes can be eliminated. This parameter should be disabled if possible. Default: false.
- playbackDynamicExtents. During playback, the region extents can be fixed or dynamic. The conventional notion of DDM regions regards them as dynamically changing extents to reflect the state of simulation data (for example, surrounding an entity’s position). An alternative approach is for the regions to be fixed and the object attribute instances move from region to region. If it is known that region extents never change, the overhead of checking for changes can be eliminated. This parameter should be disabled if possible. Default: false.
- allowPlaybackWithoutRegions. During playback, it may happen that a region association cannot be established. In these cases, the Logger sends the data without region association. Disable this parameter if the federation agreement requires that all data must be transmitted with associated regions. Default: true.
- recordConveyedRegions. Enable this parameter to record conveyed regions. Default: true.
- requestUpdates. Requesting updates can result in spikes in network traffic, especially since it is often performed by late joining federates when the exercise is already populated with many objects. In some DDM federations, object heartbeats are used instead of update requests. Disable this parameter to prevent the Logger from making requests for updates.
- subscribeUnspecifiedAttributes. The Logger may not be able to determine a region association to apply to an interaction class or object class attribute subscription. This situation may occur if the interaction or class does not specify a routing space or dimension in the FOM. It can also happen if the subscribeMode is configured as SubscribeRegionsAreSpecified, but some classes or attributes are left unspecified. By default, the Logger subscribes to these interaction classes and object class attributes without using a region association (in effect a global subscription). Disable this parameter if the Logger should only subscribe when a region association can be used. Default: true.
SetDisableTimeManagementTest disableTesting(bool) Disables testing for Time Management if that test causes the Logger to behave badly. Ordinarily, when Time Management is enabled, when the Logger connects, it tries to become a time constrained federate to see if Time Management is enabled in the RTI. If it succeeds, the Logger sets Time Management settings as configured by the user. In some cases, this test causes the Logger to hang. If this problem occurs, setting disableTesting to true turns off the test. However, time management features are disabled.
SetDrainInput(double maxTime, double minTime) Specifies the minimum and maximum amount of time, in seconds, to spend reading messages from the exercise connection (that is, the network) each tick.
SetDynamicNamePrefix prefix (string) Specifies the prefix that the Logger attaches to the beginning of object names that begin with HLA_ when it is recording exercises.
SetHeartbeatIntervals "className(string):interval(float):inheritable(bool) ..." Specifies a heartbeat interval for playback. You can specify multiple classes. For details, please see “Configuring HLA Heartbeating“ on page 390.
SetIgnoreAdvisories mode(bool) Specifies the Logger’s response to HLA advisory messages. You must specify this command before the connect command. Default: false.
SetPassiveSubscription mode(bool) Configures passive subscription for HLA. You must specify this command before the connect command. Default: false.
SetSubscriptionLists objectClasses(stringList) interactionClasses(stringList) Sets the class subscription list. To subscribe to a class the class must be in the list. Each class must be specified using the full HLA class name (including parents). Some operating systems will not allow sufficiently long command line buffers to allow use of this command on the command line. The Logger must be connected. The updated subscription list takes effect the next time you record.
SetTimeManagement timeConstrainedRecording(bool) timeConstrainedPlayback(bool) timeRegulatingRecording(bool) timeRegulatingPlayback(bool) lookahead(double) Configures Time Management options. The timeConstrainedPlayback and timeRegulatingRecording arguments must be included on the command line, but are not supported and are ignored.
SetTimeoutIntervals "className(string):interval(float):inheritable(bool) ..." Specifies an object timeout for recording. You can specify multiple classes. For details, please see “Configuring HLA Timeouts“ on page 390.

Editor Domain Commands

Table 48 describes the commands in the Editor domain.

Note: Editing operations can be performed only on files that have been opened for playback. After you perform an edit, the edited file is unsaved. You must save it to preserve the change.

Table 48: Editor domain commands

Command Description
AppendFileToEnd filename(string) Appends the file filename to the end of the open file.
ClearSection start(time) end(time) Removes all packets between the start and end times in a file.
ConvertFile Converts the current file to the latest file format. This command is not valid for files that are already in the latest file format.
CutSection start(time) end(time) Removes all packets between the start and end times in a file. All packets after the end time are offset so that the first packet after the end time is now at the start time.
ExportFile exportFormat(string) destination(string) checkpoint(bool) openAfterExport(bool) Exports a file using a given exportFormat to a destination. The last two parameters are only used when exporting the a Logger file. The Logger tries to export using the exportFormat and the destination. If checkpoint is true and the file is a Logger file, new checkpoints are generated for the output.
If openAfterExport is true and the file is a Logger file, the Logger closes the current file and tries to open the new file.
The valid exportFormat strings are based upon the registered export objects. The valid strings are identical to the Export and Export Selection menu commands in the GUI. The formats supplied with the Logger are Plain Text (if the lgrDump plug-in is loaded) and Logger File (export to a Logger file).
The destination typically is a filename (but does not need to be) and is specific to the exportFormat. The Plain Text exporter exports to any filename, but is typically exported to a .txt file. The Logger File exporter exports to a .lgr file and adds that extension if it is not in the destination string. Other exporters may encode the destination differently.
ExportSection exportFormat(string) destination(string) start(time) end(time) offset(double) checkpoint(bool) openAfterExport(bool) Exports a section of a file using a given exportFormat to a destination. This command works just like the ExportFile command except that is exports a segment of a file rather than the entire file.
MergeInFile filename(string) offset(double) Merges the Logger file filename into the open file. An optional offset is applied to all packets from the file before being combined with the current data.
OffsetTime offset(double) Offsets the time of the packets in the open file by the offset value. The offset value can be positive or negative. However, if you specify a negative offset, any data that results with a time less than zero is lost.
PrefixFileToStart filename(string) Inserts the file named filename at the start of the open file.
TrimStart Removes any dead time from the start of the file and offset all packets so that the first packet time stamp is 0.0.

本站文档由 北京智网畅联科技有限公司 整理、翻译并提供 · Documentation compiled and provided by Beijing ZNetLink Technology Co., Ltd.

交流群 · QQ Group:OPNET/智网妙算网络仿真交流群(群号 486383494)

原文档 © 2017 Riverbed Technology · 本站为公益翻译,由 AI 辅助完成,请仔细甄别

Original documentation © 2017 Riverbed Technology. Community translation, AI-assisted. Contact: jiazequn@znetlink.com