Multi-Federate Logger for 3DNV Quick Reference Card
Logger Commands
| Command | Description |
|---|---|
| System domain commands | |
DeleteFile filename (string) |
Deletes the specified file. |
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. |
SetFastJumpsWithoutDiff |
Uses checkpoints 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 |
Limits how long the Logger can spend reading packets during playback. |
SetTempDir directory(string) |
Sets the directory in which the Logger stores temporary Logger files. |
| Player domain commands | |
ClosePlaybackFile |
Closes the current playback file. |
OpenFile filename (string) |
Opens the specified file for playback. |
Pause |
Pauses playback. |
Play |
Starts playback. If the Logger is already playing this command has no effect. |
PlayPause |
Toggles between the paused and play state. |
Restart |
Starts playing from the beginning of the file. |
RevertFile |
Reverts a previously saved, but currently unsaved file to the previously saved state. |
SaveFile |
Saves a previously saved, but currently unsaved file to its current file name. |
SaveFileAs filename (string) |
Saves the current file to new file. |
SetBackupOnSave backup (bool) |
Enables or disables automatic backup of previously saved files when saving edited files. |
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. |
StopPlayback |
Stops playback. This command has no effect if the Logger is not in the playback state. |
Unpause |
Resumes playback. This command has no effect if the Logger is not paused. |
| Recorder domain commands | |
CancelRecording |
Cancels the current recording. |
CloseRecordFile |
Closes the file currently recording. |
NewFile filename(string) overwrite (bool) |
Opens a new file for recording. |
PauseRecording |
Pauses the recording process. |
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. |
SetPauseOnRecordAs record (bool) |
Determines how the Logger behaves when given the Record As command. |
SetStopCondition condition (int) |
Specifies the stop condition for recording as follows: - 0 — no condition - 1 — duration (enables SetStopDuration) - 2 — file size (enables SetStopSize). |
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. |
| Simulation domain commands (protocol-independent commands) | |
Connect |
Connects to the network simulation using the previously set parameters. |
Disconnect |
Disconnects from the network simulation. |
SetRemoteControlSettings process (bool) record (bool) allowDelete (bool) |
Specifies how the Logger responds to Logger Control messages. |
SetScaleAttributes scale (bool) |
Enables or disables attribute scaling due to changes in playback speed. |
SetVRFFiltering filter (bool) loId (int) hiId (int) |
Configures VR-Forces message filtering. |
| HLA-specific commands | |
LoadSubscriptionListFile filename (string) |
Loads a subscription list file. |
SaveSubscriptionListFile filename (string) |
Saves the subscription settings to an XML file with the specified name. |
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)The federateType, fomModules, and MIM parameters apply only to HLA Evolved. |
Specifies HLA connection parameters indicated by the argument names. |
SetDdmParameters enableDdm playbackMode subscribeMode playbackDynamicAssociation playbackDynamicExtents allowPlaybackWithoutRegions recordConveyedRegions requestUpdates subscribeUnspecifiedAttributes |
Specifies DDM parameters. |
SetDisableTimeManagementTest disableTesting (bool) |
Disables testing for time management if that test causes the Logger to behave badly. |
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. |
SetIgnoreAdvisories mode (bool) |
Specifies the Logger’s response to HLA advisory messages. Default: false. |
SetPassiveSubscription mode (bool) |
Configures passive subscription for HLA. Default: false. |
SetSubscriptionLists objectClasses (stringList) interactionClasses (stringList) |
Sets the class subscription list. |
SetTimeManagement timeConstrainedRecording (bool) timeConstrainedPlayback (bool) timeRegulatingRecording (bool) timeRegulatingPlayback (bool) lookahead (double) |
Configures Time Management options. |
SetTimeoutIntervals "className(string):interval(float):inheritable(bool) ..." |
Specifies an object timeout for recording. You can specify multiple classes. |
| Editor domain commands | |
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. |
CutSection start (time) end (time) |
Removes all packets between the start and end times in a file. |
ExportFile exportFormat (string) destination (string) checkpoint (bool) openAfterExport (bool) |
Exports a file using a given exportFormat to a destination.. |
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. |
MergeInFile filename (string) offset (double) |
Merges the Logger file filename into the open file. |
OffsetTime offset (double) |
Offsets the time of the packets in the open file by the offset value. |
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. |
Keyboard Shortcuts
| Action | Key | Action | Key |
|---|---|---|---|
| Annotations | Shift+A | Offset Time | Ctrl+Shift+O |
| Append to End | Ctrl+Shift+E | Open | Ctrl+O |
| Clear Section | Ctrl+Shift+Delete | Pause | Ctrl+P |
| Close | Ctrl+W | Play | Ctrl+P |
| Connection | Ctrl+Shift+C | Preferences | Ctrl+Shift+P |
| Create Instant Point Annotation | \ | Prefix to Start | Ctrl+Shift+W |
| Create Instant Range Annotation | [ | Properties | Return |
| Create Point Annotation | Ctrl+\ | Record | Ctrl+R |
| Create Range Annotation | Ctrl+[ | Record As | Ctrl+N |
| Data View | Shift + D | Record To Multiple FIles | Ctrl+M |
| Decrease Speed | Ctrl+Down | Revert | Ctrl+Shift+R |
| Delete Annotation | Delete | Save | Ctrl+Shift+S |
| Delete Section | Ctrl+X | Save As | Ctrl+Shift+A |
| Disconnect | Ctrl+D | Save Recorded Data | Ctrl+Shift+S |
| Exit | Ctrl+Q | Set Start and End Times | Ctrl+B |
| Increase Speed | Ctrl+Up | Set Zoom | Ctrl+I |
| Jump to End | End | Stop | Ctrl+S |
| Jump to Start | Home | Toggle Loop at End | Ctrl+L |
| Jump to Time | Ctrl+T | Trim Start | Ctrl+Shift+T |
| Merge In File | Ctrl+Shift+I | Update Annotation | ] |
| Modify Annotation | Return | Upgrade File Format | Ctrl+Shift+U |
| Object Statistics | Shift + O |
Command-line Options
| Option | Description |
|---|---|
--allowAllRemoteControl mode |
Allow (1) or do not allow (0) remote control PDUs. |
-c mode |
If mode = 1, show the Logger console. |
--configFile filename |
Specifies the confiuration file to load. |
--ignore_rest |
Ignore all arguments after this one. |
-h |
Displays a brief summary of Logger command-line arguments. |
-l logfile |
Specifies a file to send notification messages to. Default: logger.log. |
--loggerTickRate rate |
The interval for the Logger tick rate, in milliseconds. |
-m level |
Specifies the notification level for VR-Link messages. Range 0-4. |
-n level |
Specifies the notification level for Logger messages. Range 0-4. |
-r command |
Specifies a Logger command to run. Can be used multiple times. |
-v |
Displays version information and exits. |
| HLA Only | |
-f libname |
Specifies the FOM Mapper to use if you are not using the default FOM. |
--fomMapperInitData data |
Specifies FOM Mapper initialization data, if required. |
-F fedfile |
Specifies the FED file for the exercise. |
--ignoreAdvisories mode |
If 1, ignore HLA advisory messages. If 0, do not ignore. |
-l lookahead |
Specify the lookahead, in seconds. |
-N federate_name |
Specifies the federate name for the Logger federate. |
--rprFomVersion version |
Specifies the version of the RPR FOM to use. |
--rprFomRevision revision |
If using RPR FOM 2.0017, specifies the revision to use. |
--ignoreAdvisories {0|1} |
Specifies whether (1) or not (0) the Logger ignores advisory messages. |
--useEmptyFomMapper {0|1} |
Specifies whether (1) or not (0) the Logger uses an empty FOM Mapper. |
-u {0|1} |
Enable and select or disable constrained-time mode. Overrides -w. |
-w {0|1} |
Enables or disables use of Time Management, but does not select it. |
-x ExName |
Sets federation execution name. Default: VR-Link. |