From 9180013cf76d99a6f6aeb685164cdaa36b50f906 Mon Sep 17 00:00:00 2001
From: git <tdnorbra@nps.edu>
Date: Sun, 15 Sep 2024 22:09:30 -0700
Subject: [PATCH] [Terry N.] correct notes
---
viskit/doc/ViskitSoftwareDesignSummary.txt | 42 +++++++++++-----------
1 file changed, 21 insertions(+), 21 deletions(-)
diff --git a/viskit/doc/ViskitSoftwareDesignSummary.txt b/viskit/doc/ViskitSoftwareDesignSummary.txt
index 308791fac0..f7004b2040 100644
--- a/viskit/doc/ViskitSoftwareDesignSummary.txt
+++ b/viskit/doc/ViskitSoftwareDesignSummary.txt
@@ -18,7 +18,7 @@ ${user.home}. Here, configuration files are placed that can be modified from
Viskit by selecting File -> Settings. Things such as what panels to expose, the
"look and feel" of the UI, size of the UI frame, what project space was last
opened, what files were recently opened, and other project history data are
-recorded. If note is that macOS works best with the platform L&F while WIN
+recorded. Of note is that macOS works best with the platform L&F while WIN
machines work best with the default L&F. The colorization of EG compilation
status only work on WIN when using the default L&F. Various logging output files
are also generated and placed in a logs directory for later reference should an
@@ -82,7 +82,7 @@ Assembly XML file modifications.
1) A DirectoryWatch is first set on a /tmp location for EG and Assy files. A
listener listens for the opening of, or changes to these files which ensures
that these copies receive any modifications and are checked before saving them
-back out to the original file. In a nutshell, working changes are tracked here
+back out to the original file. In a nutshell, working changes are tracked here
until the file is validated, then all changes are copied back to the orig.
files.
@@ -95,10 +95,10 @@ XML files. These files are first validated against an EG schema, after which
java source is then generated and placed in build/src. The source is then
compiled and the completed byte code is placed in build/classes. Both src and
class directories observe package structures. During the first successful save
-of an EG XML file, its MD5 hash is generated a recndorded in the
-viskitProject.xml project file along with the path to its generated byte code
-(*.class). The build/classes directory is then placed on the live ClassLoader,
-the same used to compile these EGs.
+of an EG XML file, its MD5 hash is generated a recorded in the viskitProject.xml
+project file along with the path to its generated byte code (*.class). The
+build/classes directory is then placed on the live ClassLoader; the same used to
+compile these EGs.
Simultaneously, when an EG is successfully compiled, its icon symbol is placed
on the EG Node pallette of the Assembly Editor panel. This is more commonly
@@ -170,13 +170,13 @@ if any EGs are subclassed from other EGs, these will not open automatically.
Also, if the last remaining Assy file is closed, all open EGs will close
including any non-associated EG files that were also opened.
-7) At this point, the paths of the any opened Assey and EG files are recorded in
-the .viskit/c_app.xml file and will be opened upon next Viskit launch. The last
+7) At this point, the paths of any opened Assy and EG files are recorded in the
+~.viskit/c_app.xml file and will be opened upon next Viskit launch. The last
open Viskit project, as well as its history of Assy and EG files will be listed
in the File -> Recents menu selections for each editor.
8) Opened Assy files can now be modified, or new Assy files can be created. EG
-(blue) and PCL (pink) nodes can be dragged across from the LEGOs tree panel, or
+(blue) and PCL (pink) nodes can be dragged across from the LEGOs tree panels, or
menu items can be invoked to do the same. EG nodes are parameterized via dialog
wizards. RandomVariates are instantiated via the RV Factory static getInstance
method utilizing (String, Object...) parameters. Adapters, SimEventListeners
@@ -189,21 +189,21 @@ selected from the Assy Editor which fires off a few events:
- validate and compile the Assy
- place compiled source on the classpath
- prepare arguments to launch a separate thread for the Assy
-- populate the Assy Run panel with replication selections, reset Sim start time to 0.0
+- populate the Assy Run panel with replication selections
+- reset Sim start time to 0.0
- switch panel view to the Assy Run panel
10) When the Simulation Run VCR button is selected, the Assembly is launched via
-a Thread who's ClassLoader context is separate (new) from the ClassLoader that
-Viskit is currently running. This is to eliminate any in memory static
-references to any previously initialized Assembly parameters thereby giving the \
-current Assembly a clean slate to run independently. The main Thread run method
-for each XML Assembly file is via subclass of ViskitAssembly which subclasses
-BasicAssembly which contains the run method. Subsequent selection of the VCR
-run button will produce the exact same results if nothing in the Assy. has been
-altered.
+a Thread of which it's ClassLoader context is separate (new) from the
+ClassLoader that Viskit is currently running. This is to eliminate any in
+memory static references from any previously initialized Assembly parameters
+thereby giving the current Assembly a clean slate to run independently. The
+main Thread run method for each XML Assembly file is via subclass of
+ViskitAssembly which subclasses BasicAssembly which contains the run method.
+Subsequent selection of the VCR run button will produce the exact same results
+if nothing in the Assy. has been altered.
11) The simulation can be immediately stopped via the VCR stop button, or it can
run until its sim. stop time has expired for the number of replications
-selected. Step-through and rewind buttons are implemented, but not working
-quite right, so, they are disabled upon instantiation from the
-InternalAssemblyRunner as of now.
+selected. The default random seed from Simkit is utilized to start the
+simulation run and cannot be altered at this time.
--
GitLab