Changeset 664 in tmcsimulator for trunk/src/tmcsim/cadsimulator/CADServer.java

Timestamp:

09/14/2022 03:31:54 PM (4 years ago)

Author:

jdalbey

Message:

Multifile commit - revise source to match revisions to config filenames. Fix broken system tests. Fix defect #160.

File:

• trunk/src/tmcsim/cadsimulator/CADServer.java (modified) (13 diffs)

trunk/src/tmcsim/cadsimulator/CADServer.java

@@ -27 +27 @@
 
 /**
- * CADSimulator is main class for the CAD Simulator application. At construction
- * the Coordinator, CoordinatorViewer, and all CAD Simulator Managers are
+ * CADServer is main class for the CAD Simulator application. 
+ * CADServer must be running before starting any other components of the TMCSim.
+ * At construction the Coordinator, CoordinatorViewer, and all CAD Simulator Managers are
  * initialized and data relationships are established. Simulation control is
- * managed through the Coordinator and Managers. The CADSimulator contains the
+ * managed through the Coordinator and Managers. The CADServer contains the
  * instances of all Manager Objects that are used to control the Simulation flow
  * of data.<br>
+ * There is a GUI (and for testing, a text-based UI) that displays the state
+ * of the server.
  * <br>
+ * A properties file contains settings for many parameters of the CADServer<br>
  *
- * The CADSimulator is initialized with a properties file containing the
- * following data items:<br>
- * <code>
- * -----------------------------------------------------------------------------<br>
- * CADClientPort The port number to use for remote CAD Client connections.<br>
- * CoordinatorRMIPort The port number to use for binding the Coordinator.<br>
- * CMSDiversionXML The filepath for the xml file containing initialization data
- * for the Diversion "database." AudioFileLocation The root directory path where
- * audio files are referenced from.<br>
- * ParamicsProperties The filepath for the properties file to initialize the
- * ParamicsControlManager.<br>
- * ATMSProperties The filepath for the properties file to initialize the
- * ATMSManager.<br>
- * MediaProperties The filepath for the properties file to initialize the
- * MediaManager.<br>
- * ErrorFile The filename of the error file used for logging errors.<br>
- * ----------------------------------------------------------------------------<br>
- * Example File:<br>
- * CADClientPort = 4444<br>
- * CoordinatorRMIPort = 4445<br>
- * CMSDiversionXML = ../data/cmsdiversions.xml<br>
- * AudioFileLocation = ../audio/<br>
- * ParamicsProperties = ../config/paramics.properties<br>
- * ATMSProperties = ../config/atms.properties<br>
- * MediaProperties = ../config/media.properties<br>
- * ErrorFile = cad_sim_error.xml<br>
- * </code>
- *
- * @author Matthew Cechini (mcechini@calpoly.edu) jdalbey
+ * @author Matthew Cechini (mcechini@calpoly.edu)
+ * @author John Dalbey (jdalbey@calpoly.edu)
  * @version $Date: 2009/04/17 16:27:46 $ $Revision: 1.5 $
  */
@@ -69 +46 @@
 {
 
-    private static String CONFIG_FILE_NAME = "cad_simulator_config.properties";
+    private static String CONFIG_FILE_NAME = "cad_server.properties";
     /**
      * Error logger.
@@ -76 +53 @@
 
     /**
-     * Enumeration containing properties name values. See CADSimulator class
+     * Enumeration containing properties name values. See CADServer class
      * description for more information.
      *
@@ -149 +126 @@
     /** NOTE: Protected fields are accessed by Coordinator */
     /**
-     * CADSimulatorViewer instance.
+     * CADServerViewer instance.
      */
     protected static CADViewer theViewer;
@@ -189 +166 @@
     
     /**
-     * Properties file for the CADSimulator.
+     * Properties file for the CADServer, read from CONFIG_FILE_NAME.
      */
     private Properties cadServerProperties;
@@ -211 +188 @@
             cadServerProperties = new Properties();
             cadServerProperties.load(new FileInputStream(propertiesFile));
-            cadSimLogger.logp(Level.INFO, "CADSimulator", "Constructor",
+            cadSimLogger.logp(Level.INFO, "CADServer", "Constructor",
                     "Properties loaded from " + propertiesFile);
         } catch (Exception e)
         {
-            cadSimLogger.logp(Level.SEVERE, "CADSimulator", "Constructor",
+            cadSimLogger.logp(Level.SEVERE, "CADServer", "Constructor",
                     "Exception in reading properties file.", e);
             JOptionPane.showMessageDialog(new JWindow(), e.getMessage() +
@@ -233 +210 @@
             if (userInterfaceName == null)
             {
-                cadSimLogger.logp(Level.SEVERE, "CADSimulator", "Constructor",
+                cadSimLogger.logp(Level.SEVERE, "CADServer", "Constructor",
                         propertiesFile + " missing property for user interface.");
                 throw new SimulationException(SimulationException.PROPERTY_MISSING_ERROR);
@@ -244 +221 @@
             } catch (Exception exc)
             {
-                cadSimLogger.logp(Level.SEVERE, "CADSimulator", "Constructor",
+                cadSimLogger.logp(Level.SEVERE, "CADServer", "Constructor",
                         "Unable to instantiate user interface: " + userInterfaceName
                         + " " + exc);
@@ -257 +234 @@
             if (simTimeFilename == null)
             {
-                cadSimLogger.logp(Level.SEVERE, "CADSimulator", "Constructor",
+                cadSimLogger.logp(Level.SEVERE, "CADServer", "Constructor",
                         propertiesFile + " missing property for " + CAD_PROPERTIES.ELAPSED_TIME_FILE.name);
                 throw new SimulationException(SimulationException.PROPERTY_MISSING_ERROR);
@@ -267 +244 @@
             if (commentLogname == null)
             {
-                cadSimLogger.logp(Level.SEVERE, "CADSimulator", "Constructor",
+                cadSimLogger.logp(Level.SEVERE, "CADServer", "Constructor",
                         propertiesFile + " missing property for " + CAD_PROPERTIES.CAD_COMMENTS_LOG.name);
                 throw new SimulationException(SimulationException.PROPERTY_MISSING_ERROR);
@@ -317 +294 @@
         } catch (RemoteException e)
         {
-            cadSimLogger.logp(Level.SEVERE, "CADSimulator", "Constructor",
+            cadSimLogger.logp(Level.SEVERE, "CADServer", "Constructor",
                     "Exception in starting Coordinator.", e);
 
@@ -336 +313 @@
         } catch (Exception e)
         {
-            cadSimLogger.logp(Level.SEVERE, "CADSimulator", "Constructor",
+            cadSimLogger.logp(Level.SEVERE, "CADServer", "Constructor",
                     "Exception in parsing CMSDiversion xml file.", e);
 
@@ -472 +449 @@
         } catch (Exception e)
         {
-            cadSimLogger.logp(Level.SEVERE, "CADSimulator", "Main",
+            cadSimLogger.logp(Level.SEVERE, "CADServer", "Main",
                     "Error initializing application.", e);