Changeset 6 in tmcsimulator for trunk/src/tmcsim/paramicscommunicator

Timestamp:

04/20/2016 02:29:52 PM (10 years ago)

Author:

jdalbey

Message:

Multifile commit. Add version # to Paramics Communicator. Move Load button in Sim Mgr. Add several tests. Add package jars target.

Location:

trunk/src/tmcsim/paramicscommunicator

Files:

• ParamicsCommunicator.java (modified) (6 diffs)
• ParamicsFileReader.java (modified) (2 diffs)
• gui/ParamicsCommunicatorGUI.java (modified) (8 diffs)

trunk/src/tmcsim/paramicscommunicator/ParamicsCommunicator.java

@@ -17 +17 @@
 import java.util.Properties;
 import java.util.TreeMap;
-import java.util.logging.FileHandler;
 import java.util.logging.Level;
 import java.util.logging.Logger;
-
 import javax.swing.JOptionPane;
 import javax.swing.UIManager;
-
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
-
 import tmcsim.common.CADProtocol.PARAMICS_ACTIONS;
 import tmcsim.common.CADProtocol.PARAMICS_COMM_TAGS;
@@ -32 +28 @@
 import tmcsim.paramicscommunicator.FileRegUpdate.REG_TYPE;
 import tmcsim.paramicscommunicator.gui.ParamicsCommunicatorGUI;
-import tmcsim.simulationmanager.SimulationManager;
-
 
 /**
- * ParamicsCommunicator is the main class for this module.  The Paramics 
- * Communicator is used to provide communication between the CAD Simulator
- * and the Paramics traffic modeler.  While the application is running, data 
- * is received on a socket from the CAD Simulator.  Transmitted data are
- * XML documents containing information and action commands. The CAD Simulator 
- * registers readers and writers with the ParamicsCommunicator.  Any data read 
- * by a ParamicsReader is sent back to the CAD Simulator.  All data to be 
- * written by a ParamicsWriter is received through the socket.<br><br>  
- * The properties file for the ParamicsCommunicator class contains the following data.<br>
+ * ParamicsCommunicator is the main class for this module. The Paramics
+ * Communicator is used to provide communication between the CAD Simulator and
+ * the Paramics traffic modeler. While the application is running, data is
+ * received on a socket from the CAD Simulator. Transmitted data are XML
+ * documents containing information and action commands. The CAD Simulator
+ * registers readers and writers with the ParamicsCommunicator. Any data read by
+ * a ParamicsReader is sent back to the CAD Simulator. All data to be written by
+ * a ParamicsWriter is received through the socket.<br><br>
+ * The properties file for the ParamicsCommunicator class contains the following
+ * data.<br>
  * <code>
  * -----------------------------------------------------------------------------<br>
- * Socket Port          The port number to use for socket communication.<br>
- * Working Directory    The working directory use for Paramics file communication.<br>
- * Error File           The target file to use for error logging.<br>
+ * Socket Port The port number to use for socket communication.<br>
+ * Working Directory The working directory use for Paramics file
+ * communication.<br>
+ * Error File The target file to use for error logging.<br>
  * -----------------------------------------------------------------------------<br>
  * Example File: <br>
- * SocketPort          = 4450 <br>
- * WorkingDirectory    = c:\\tmc_simulator\\ <br>
- * ErrorFile           = sim_mgr_error.xml <br>
+ * SocketPort = 4450 <br>
+ * WorkingDirectory = c:\\tmc_simulator\\ <br>
+ * ErrorFile = sim_mgr_error.xml <br>
  * -----------------------------------------------------------------------------<br>
  * </code>
  *
  * @author Matthew Cechini (mcechini@calpoly.edu)
- * @version $Date: 2009/04/17 16:27:46 $ $Revision: 1.7 
+ * @version $Date: 2009/04/17 16:27:46 $ $Revision: 1.7
  */
-public class ParamicsCommunicator extends Observable implements Observer, Runnable {
-
-    /** Error logger. */
+public class ParamicsCommunicator extends Observable implements Observer, Runnable
+{
+
+    /**
+     * Error logger.
+     */
     private static Logger paramLogger = Logger.getLogger("tmcsim.paramicscommunicator");
-    
+
     /**
      * Enumeration containing property names.
+     *
      * @author Matthew Cechini
      */
-    private static enum PROPERTIES {
-        
-        SOCKET_PORT ("SocketPort"),
-        WORKING_DIR ("WorkingDirectory");       
-        
+    private static enum PROPERTIES
+    {
+
+        SOCKET_PORT("SocketPort"),
+        WORKING_DIR("WorkingDirectory");
         public String name;
-        
-        private PROPERTIES(String n) {
+
+        private PROPERTIES(String n)
+        {
             name = n;
         }
     }
-    
-        
-    /** Properties object. */
-    private Properties paramicsCommProp = null; 
-    
-    /** Current working directory where files will be read and written */
+    /**
+     * Properties object.
+     */
+    private Properties paramicsCommProp = null;
+    /**
+     * Current working directory where files will be read and written
+     */
     private String workingDirectory = null;
-    
-    /** Socket used to create socket communication with the CAD Simulator.  */
+    /**
+     * Socket used to create socket communication with the CAD Simulator.
+     */
     private ServerSocket serverSocket = null;
-    
-    /** Soccket used to communicate with CAD Simulator.*/
-    private Socket paramicsSocket = null;   
-    
-    /** Input Stream for reading data from the CAD Simulator. */
+    /**
+     * Soccket used to communicate with CAD Simulator.
+     */
+    private Socket paramicsSocket = null;
+    /**
+     * Input Stream for reading data from the CAD Simulator.
+     */
     private ObjectInputStream in = null;
-    
-    /** Output Stream for writing data to the CAD Simulator.  */
+    /**
+     * Output Stream for writing data to the CAD Simulator.
+     */
     private ObjectOutputStream out = null;
-    
-    /** Map of all current ParamicsFileWriters referenced by I/O ID. */
+    /**
+     * Map of all current ParamicsFileWriters referenced by I/O ID.
+     */
     private TreeMap<String, ParamicsFileWriter> writers = null;
-    
-    /** Map of all current ParamicsFileReaders referenced by I/O ID.  */
+    /**
+     * Map of all current ParamicsFileReaders referenced by I/O ID.
+     */
     private TreeMap<String, ParamicsFileReader> readers = null;
-    
-    /** The view class for the ParamicsCommunicator. */
+    /**
+     * The view class for the ParamicsCommunicator.
+     */
     private ParamicsCommunicatorGUI theGUI;
-    
-    /**
-     * Constructor.  Read in the property values.  If the properties file 
-     * does not contain a value for the working directory, open a dialog
-     * to prompt the user for the path of the Paramics working directory.
-     * An empty string is not accepted.  A null signifies that the user
-     * pressed cancel.  Prompt the user to accept the cancel and exit the
-     * application if confirmed.  Continue until a valid directory has been
-     * entered, that exists, and append a '\' to the end of the directory
-     * if necessary.
-     * 
-     * Initialize the Sockets
-     * and begin communication.
-     *
-     * @param propertiesFilePath File Path of ParamicsCommunicator properties file.
-     */
-    public ParamicsCommunicator (String propertiesFile) 
-    {
-        
+
+    /**
+     * Constructor. Read in the property values. If the properties file does not
+     * contain a value for the working directory, open a dialog to prompt the
+     * user for the path of the Paramics working directory. An empty string is
+     * not accepted. A null signifies that the user pressed cancel. Prompt the
+     * user to accept the cancel and exit the application if confirmed. Continue
+     * until a valid directory has been entered, that exists, and append a '\'
+     * to the end of the directory if necessary.
+     *
+     * Initialize the Sockets and begin communication.
+     *
+     * @param propertiesFilePath File Path of ParamicsCommunicator properties
+     * file.
+     */
+    public ParamicsCommunicator(String propertiesFile)
+    {
+
         writers = new TreeMap<String, ParamicsFileWriter>();
         readers = new TreeMap<String, ParamicsFileReader>();
@@ -133 +141 @@
         theGUI = new ParamicsCommunicatorGUI();
         addObserver(theGUI);
-        theGUI.addWindowListener(new WindowListener() {         
-            public void windowActivated(WindowEvent arg0) {};
-            public void windowClosed(WindowEvent arg0) {};
-            public void windowClosing(WindowEvent arg0) {
+        theGUI.addWindowListener(new WindowListener()
+        {
+            public void windowActivated(WindowEvent arg0)
+            {
+            }
+
+            ;
+            public void windowClosed(WindowEvent arg0)
+            {
+            }
+
+            ;
+            public void windowClosing(WindowEvent arg0)
+            {
                 System.exit(0);
             }
-            public void windowDeactivated(WindowEvent arg0) {};
-            public void windowDeiconified(WindowEvent arg0) {};
-            public void windowIconified(WindowEvent arg0) {};
-            public void windowOpened(WindowEvent arg0) {};
+
+            public void windowDeactivated(WindowEvent arg0)
+            {
+            }
+
+            ;
+            public void windowDeiconified(WindowEvent arg0)
+            {
+            }
+
+            ;
+            public void windowIconified(WindowEvent arg0)
+            {
+            }
+
+            ;
+            public void windowOpened(WindowEvent arg0)
+            {
+            }
+        ;
         });
-        
-        try {
+
+        try
+        {
             paramicsCommProp = new Properties();
             paramicsCommProp.load(new FileInputStream(propertiesFile));
-            
-            if(paramicsCommProp.getProperty(PROPERTIES.SOCKET_PORT.name) == null) 
-            {
-                JOptionPane.showMessageDialog(theGUI, 
-                        "Properties file missing CAD Simulator Port information.", 
+
+            if (paramicsCommProp.getProperty(PROPERTIES.SOCKET_PORT.name) == null)
+            {
+                JOptionPane.showMessageDialog(theGUI,
+                        "Properties file missing CAD Simulator Port information.",
                         "Invalid Configuration", JOptionPane.ERROR_MESSAGE);
                 System.exit(0);
-            }
-            else if(paramicsCommProp.getProperty(PROPERTIES.WORKING_DIR.name) == null || 
-                    paramicsCommProp.getProperty(PROPERTIES.WORKING_DIR.name).length() == 0) {
-                
-                try {
+            } else if (paramicsCommProp.getProperty(PROPERTIES.WORKING_DIR.name) == null
+                    || paramicsCommProp.getProperty(PROPERTIES.WORKING_DIR.name).length() == 0)
+            {
+
+                try
+                {
                     String workingDir = null;
-                    
-                    while (workingDir == null || workingDir.length() == 0) {                        
+
+                    while (workingDir == null || workingDir.length() == 0)
+                    {
                         workingDir = JOptionPane.showInputDialog(null,
                                 "Please set the output directory for Paramics communication.",
                                 "Paramics Working Directory", JOptionPane.QUESTION_MESSAGE);
-                        
-                        if(workingDir == null) {
-                            
-                        }
-                        else if(!new File(workingDir).exists()) {
+
+                        if (workingDir == null)
+                        {
+                        } else if (!new File(workingDir).exists())
+                        {
                             JOptionPane.showMessageDialog(null,
                                     "Directory does not exist.",
                                     "Invalid Working Directory", JOptionPane.WARNING_MESSAGE);
-                            
+
                             workingDir = null;
-                        }
-                        else if(!new File(workingDir).isDirectory()) {
+                        } else if (!new File(workingDir).isDirectory())
+                        {
                             JOptionPane.showMessageDialog(null,
                                     workingDir + " is not a directory.",
                                     "Invalid Working Directory", JOptionPane.WARNING_MESSAGE);
-                            
+
                             workingDir = null;
-                        }                       
+                        }
                     }
 
-                    if(workingDir.lastIndexOf("\\") != workingDir.length()-1) {
+                    if (workingDir.lastIndexOf("\\") != workingDir.length() - 1)
+                    {
                         workingDir = workingDir + "\\";
                     }
-                    
-                    paramicsCommProp.setProperty(PROPERTIES.WORKING_DIR.name, workingDir);      
+
+                    paramicsCommProp.setProperty(PROPERTIES.WORKING_DIR.name, workingDir);
                     paramicsCommProp.store(new FileOutputStream(propertiesFile), "");
-                } catch (IOException ioe) {
-                    paramLogger.logp(Level.SEVERE, "ParamicsCommunicator", "Constructor", 
+                } catch (IOException ioe)
+                {
+                    paramLogger.logp(Level.SEVERE, "ParamicsCommunicator", "Constructor",
                             "Exception in writing properties file.", ioe);
                 }
-                
+
             }
 
             workingDirectory = paramicsCommProp.getProperty(
-                    PROPERTIES.WORKING_DIR.name).trim();                    
-
-        } catch (Exception e) {
-            paramLogger.logp(Level.SEVERE, "ParamicsCommunicator", "Constructor", 
+                    PROPERTIES.WORKING_DIR.name).trim();
+
+        } catch (Exception e)
+        {
+            paramLogger.logp(Level.SEVERE, "ParamicsCommunicator", "Constructor",
                     "Exception in reading properties file.", e);
         }
-        
-        
-        try {
+
+
+        try
+        {
             initializeSockets(Integer.parseInt(paramicsCommProp.getProperty(
                     PROPERTIES.SOCKET_PORT.name).trim()));
-        }
-        catch (Exception e) {
-            paramLogger.logp(Level.SEVERE, "ParamicsCommunicator", "Constructor", 
+        } catch (Exception e)
+        {
+            paramLogger.logp(Level.SEVERE, "ParamicsCommunicator", "Constructor",
                     "Exception in initializing sockets.", e);
         }
 
     }
-    
+
     /**
      * Transmits a message XML document object to the CAD Simulator.
@@ -224 +265 @@
      * @param mess The ParamicsCommMessage to be transmitted.
      */
-    private void write(Document mess) {
-        
-        synchronized(paramicsSocket) {
-            try {
+    private void write(Document mess)
+    {
+
+        synchronized (paramicsSocket)
+        {
+            try
+            {
                 out.writeObject(mess);
                 out.flush();
-            }
-            catch (Exception e) {
-                paramLogger.logp(Level.SEVERE, "ParamicsCommunicator", "write", 
+            } catch (Exception e)
+            {
+                paramLogger.logp(Level.SEVERE, "ParamicsCommunicator", "write",
                         "Exception in writing to the socket.", e);
             }
         }
     }
-    
-    /**
-     * Observer/Observable update method.  The Paramics Communicator observers
-     * registered ParamicsReaders.  When messages are to be sent, they are sent
-     * through this method.  All messages are ParamicsCommMessage objects.  Send 
+
+    /**
+     * Observer/Observable update method. The Paramics Communicator observers
+     * registered ParamicsReaders. When messages are to be sent, they are sent
+     * through this method. All messages are ParamicsCommMessage objects. Send
      * these messages to the write() method for transmission on the socket.
      */
-    public void update(Observable o, Object arg) {      
-
-        if(arg instanceof Document) {
-            write((Document)arg);               
-        }           
-    }
-    
-    /**
-     * Runnable method.  While this thread is not interrupted, read in an 
-     * object from the socket input stream.  If an object exists, call
-     * doMessage() to parse and perform the received action in the message.  
-     */
-    public void run() {
-        
-        while(true) {                       
-            try {
-                doMessage((Document)in.readObject());
-            } 
-            catch(SocketTimeoutException ste) {
+    public void update(Observable o, Object arg)
+    {
+
+        if (arg instanceof Document)
+        {
+            write((Document) arg);
+        }
+    }
+
+    /**
+     * Runnable method. While this thread is not interrupted, read in an object
+     * from the socket input stream. If an object exists, call doMessage() to
+     * parse and perform the received action in the message.
+     */
+    public void run()
+    {
+
+        while (true)
+        {
+            try
+            {
+                doMessage((Document) in.readObject());
+            } catch (SocketTimeoutException ste)
+            {
                 //just try again
-            }   
-            catch(EOFException eofe) {
-                paramLogger.logp(Level.SEVERE, "ParamicsCommunicator", 
+            } catch (EOFException eofe)
+            {
+                paramLogger.logp(Level.SEVERE, "ParamicsCommunicator",
                         "run", "EOF Exception in reading data from the socket.", eofe);
-            }
-            catch(Exception e) {
-                paramLogger.logp(Level.SEVERE, "ParamicsCommunicator", 
+            } catch (Exception e)
+            {
+                paramLogger.logp(Level.SEVERE, "ParamicsCommunicator",
                         "run", "Exception in reading data from the socket.", e);
 
-                JOptionPane.showMessageDialog(theGUI, 
-                        "Connection has been lost to the CAD Simulator.  " +
-                        "Paramics Communicator will now shutdown.", 
+                JOptionPane.showMessageDialog(theGUI,
+                        "Connection has been lost to the CAD Simulator.  "
+                        + "Paramics Communicator will now shutdown.",
                         "Dropped Connection", JOptionPane.ERROR_MESSAGE);
                 break;
-            }                   
-        }
-        
-        
-        try { in.close(); } catch (Exception e) {}
-        try { out.close(); } catch (Exception e) {}
-        try { serverSocket.close(); } catch (Exception e) {}
-        try { paramicsSocket.close(); } catch (Exception e) {}
-        
-    }
-    
+            }
+        }
+
+
+        try
+        {
+            in.close();
+        } catch (Exception e)
+        {
+        }
+        try
+        {
+            out.close();
+        } catch (Exception e)
+        {
+        }
+        try
+        {
+            serverSocket.close();
+        } catch (Exception e)
+        {
+        }
+        try
+        {
+            paramicsSocket.close();
+        } catch (Exception e)
+        {
+        }
+
+    }
+
     /**
      * Perform the action represented in the received XML document message.
-     * First determine if the action is from a READER, WRITER, and RESET.  
-     * If the paramics action is REGISTER, add a new ParamicsFileReader/Writer 
-     * to the local list of readers/writers and update the GUI with a 
-     * FileRegUpdate object. If the paramics action is UNREGISTER, remove the 
-     * ParamicsFileReader/Writer from the local list of readers/writers and update
-     * the GUI with a FileRegUpdate object.  If RESET is received, clear all 
-     * readers and writers. 
-     * 
+     * First determine if the action is from a READER, WRITER, and RESET. If the
+     * paramics action is REGISTER, add a new ParamicsFileReader/Writer to the
+     * local list of readers/writers and update the GUI with a FileRegUpdate
+     * object. If the paramics action is UNREGISTER, remove the
+     * ParamicsFileReader/Writer from the local list of readers/writers and
+     * update the GUI with a FileRegUpdate object. If RESET is received, clear
+     * all readers and writers.
+     *
      * @param mess Received XML document message.
      */
-    private void doMessage (Document mess) {
-        
+    private void doMessage(Document mess)
+    {
+
         Element rootElement = mess.getDocumentElement();
 
-        String id     = null;
+        String id = null;
         String action = null;
-        
-        switch(PARAMICS_COMM_TAGS.fromString(rootElement.getNodeName())) {
+
+        switch (PARAMICS_COMM_TAGS.fromString(rootElement.getNodeName()))
+        {
             case READER:
-                id     = rootElement.getAttribute(PARAMICS_COMM_TAGS.ID.tag);
+                id = rootElement.getAttribute(PARAMICS_COMM_TAGS.ID.tag);
                 action = rootElement.getAttribute(PARAMICS_COMM_TAGS.ACTION.tag);
-                
-                switch(PARAMICS_ACTIONS.fromString(action)) {
+
+                switch (PARAMICS_ACTIONS.fromString(action))
+                {
                     case REGISTER:
-                        Integer interval   = Integer.parseInt(rootElement.getChildNodes().item(0).getTextContent());
-                        String  targetFile = rootElement.getChildNodes().item(1).getTextContent();
-                        
-                        readers.put(id, new ParamicsFileReader(workingDirectory, id, 
+                        Integer interval = Integer.parseInt(rootElement.getChildNodes().item(0).getTextContent());
+                        String targetFile = rootElement.getChildNodes().item(1).getTextContent();
+
+                        readers.put(id, new ParamicsFileReader(workingDirectory, id,
                                 interval, targetFile));
                         readers.get(id).addObserver(this);
                         readers.get(id).addObserver(theGUI);
-                        
+
                         setChanged();
-                        notifyObservers(new FileRegUpdate(IO_TYPE.READ, 
+                        notifyObservers(new FileRegUpdate(IO_TYPE.READ,
                                 REG_TYPE.REGISTER, id, targetFile, interval));
                         break;
-                    case UNREGISTER: 
+                    case UNREGISTER:
                         readers.get(id).deleteObserver(this);
                         readers.get(id).deleteObserver(theGUI);
@@ -333 +405 @@
 
                         setChanged();
-                        notifyObservers(new FileRegUpdate(IO_TYPE.READ, 
-                                REG_TYPE.UNREGISTER, id, null, null));                      
+                        notifyObservers(new FileRegUpdate(IO_TYPE.READ,
+                                REG_TYPE.UNREGISTER, id, null, null));
                         break;
                 }
                 break;
             case WRITER:
-                id     = rootElement.getAttribute(PARAMICS_COMM_TAGS.ID.tag);
+                id = rootElement.getAttribute(PARAMICS_COMM_TAGS.ID.tag);
                 action = rootElement.getAttribute(PARAMICS_COMM_TAGS.ACTION.tag);
-                
-                switch(PARAMICS_ACTIONS.fromString(action)) {
+
+                switch (PARAMICS_ACTIONS.fromString(action))
+                {
                     case REGISTER:
-                        String targetFile = rootElement.getChildNodes().item(0).getTextContent(); 
-                        
-                        writers.put(id, new ParamicsFileWriter(id, 
+                        String targetFile = rootElement.getChildNodes().item(0).getTextContent();
+
+                        writers.put(id, new ParamicsFileWriter(id,
                                 workingDirectory, targetFile));
                         writers.get(id).addObserver(theGUI);
-                        
+
                         setChanged();
-                        notifyObservers(new FileRegUpdate(IO_TYPE.WRITE, 
-                                REG_TYPE.REGISTER, id, targetFile, null));      
+                        notifyObservers(new FileRegUpdate(IO_TYPE.WRITE,
+                                REG_TYPE.REGISTER, id, targetFile, null));
                         break;
-                    case UNREGISTER: 
+                    case UNREGISTER:
                         writers.remove(id);
-                        
+
                         writers.get(id).deleteObserver(theGUI);
 
                         setChanged();
-                        notifyObservers(new FileRegUpdate(IO_TYPE.WRITE, 
+                        notifyObservers(new FileRegUpdate(IO_TYPE.WRITE,
                                 REG_TYPE.UNREGISTER, id, null, null));
                         break;
                     case WRITE_FILE:
-                        writers.get(id).writeMessage((Element)rootElement.getChildNodes().item(0));
+                        writers.get(id).writeMessage((Element) rootElement.getChildNodes().item(0));
                         break;
                 }
@@ -372 +445 @@
                 writers.clear();
                 break;
-        }   
-    }
-    
-    /**
-     * Method waits to accept a socket connection from the CAD Simulator.  
-     * When a connection has been established the method exits.  The input and
-     * output streams are created on the new socket.
-     * 
-     * @param socketPort Socket port to use for establishing Socket communication.
-     * @throws IOException if there is an exception in establishing Socket communication.
-     */
-    private void initializeSockets(Integer socketPort) throws IOException {
-    
+        }
+    }
+
+    /**
+     * Method waits to accept a socket connection from the CAD Simulator. When a
+     * connection has been established the method exits. The input and output
+     * streams are created on the new socket.
+     *
+     * @param socketPort Socket port to use for establishing Socket
+     * communication.
+     * @throws IOException if there is an exception in establishing Socket
+     * communication.
+     */
+    private void initializeSockets(Integer socketPort) throws IOException
+    {
+
         boolean waiting = true;
-        
-        try {
-            serverSocket = new ServerSocket(socketPort);            
-            //delay for accept timeout(milliseconds)        
-            serverSocket.setSoTimeout(10 * 1000);  
-        }
-        catch (IOException ioe) {
-            throw new IOException("Exception in creating " +
-                    "the server socket on port " + socketPort);
-        }
-        
-        while(waiting) {            
-            try{
+
+        try
+        {
+            serverSocket = new ServerSocket(socketPort);
+            //delay for accept timeout(milliseconds)
+            serverSocket.setSoTimeout(10 * 1000);
+        } catch (IOException ioe)
+        {
+            throw new IOException("Exception in creating "
+                    + "the server socket on port " + socketPort);
+        }
+
+        while (waiting)
+        {
+            try
+            {
                 paramicsSocket = serverSocket.accept();
                 waiting = false;
-            } 
-            catch(SocketTimeoutException ste) {
+            } catch (SocketTimeoutException ste)
+            {
                 System.out.println("...waiting...");
-            }   
-            catch(IOException ioe) {
-                throw new IOException("Exception in creating " +
-                        "the receiving socket on port " + socketPort);
-            }
-        }
-
-        
+            } catch (IOException ioe)
+            {
+                throw new IOException("Exception in creating "
+                        + "the receiving socket on port " + socketPort);
+            }
+        }
+
+
         //** out must be performed before in to unlock for connecting socket **//
-        try {       
-            out     = new ObjectOutputStream(paramicsSocket.getOutputStream());
-            in      = new ObjectInputStream(paramicsSocket.getInputStream());
-        }
-        catch (IOException ioe) {
-            throw new IOException("Exception in creating input " +
-                    "and output streams on socket.");
-        }
-            
-    }
-
-    /**
-     * Construct the ParamicsCommunicator with the properties file path, 
-     * either from the command line arguments or default.
-     * 
+        try
+        {
+            out = new ObjectOutputStream(paramicsSocket.getOutputStream());
+            in = new ObjectInputStream(paramicsSocket.getInputStream());
+        } catch (IOException ioe)
+        {
+            throw new IOException("Exception in creating input "
+                    + "and output streams on socket.");
+        }
+
+    }
+
+    /**
+     * Construct the ParamicsCommunicator with the properties file path, either
+     * from the command line arguments or default.
+     *
      * @param args Command line arguments.
      */
-    public static void main(String[] args) {
-
-        try
-        {
-            if(System.getProperty("PARAMICS_COMM_PROPERTIES") != null)
+    public static void main(String[] args)
+    {
+        System.setProperty("PARAMICS_COMM_PROPERTIES", "config/paramics_communicator_config.properties");
+
+        try
+        {
+            if (System.getProperty("PARAMICS_COMM_PROPERTIES") != null)
             {
                 UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
-    
+
                 new Thread(new ParamicsCommunicator(System.getProperty(
                         "PARAMICS_COMM_PROPERTIES"))).start();
-            }
-            else
-            {
-                throw new Exception ("PARAMICS_COMM_PROPERTIES system property not defined.");
-            }
-        } 
-        catch (Exception e) 
-        {
-            paramLogger.logp(Level.SEVERE, "ParamicsCommunicator", "Main", 
+            } else
+            {
+                throw new Exception("PARAMICS_COMM_PROPERTIES system property not defined.");
+            }
+        } catch (Exception e)
+        {
+            paramLogger.logp(Level.SEVERE, "ParamicsCommunicator", "Main",
                     "Error occured initializing application", e);
 
-            JOptionPane.showMessageDialog(null, e.getMessage(), 
-                    "Error - Program Exiting", JOptionPane.ERROR_MESSAGE);  
-            
+            JOptionPane.showMessageDialog(null, e.getMessage(),
+                    "Error - Program Exiting", JOptionPane.ERROR_MESSAGE);
+
             System.exit(-1);
         }
-    
-        
-    }   
-    
+
+
+    }
 }

trunk/src/tmcsim/paramicscommunicator/ParamicsFileReader.java

@@ -10 +10 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
-
 import javax.xml.parsers.DocumentBuilderFactory;
-
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
-
 import tmcsim.common.CADProtocol.PARAMICS_ACTIONS;
 import tmcsim.common.CADProtocol.PARAMICS_COMM_TAGS;
 import tmcsim.paramicscommunicator.FileIOUpdate.IO_TYPE;
 
-
 /**
- * The ParamicsFileReader handles reading fom a target file which
- * is written to by Paramics.  Once initialized, a timer task is
- * started which periodically checks the target file for updates.
- * If the file has been modified, it is read and cleared.  The read
- * data is transmitted to the CAD Simulator.
+ * The ParamicsFileReader handles reading fom a target file which is written to
+ * by Paramics. Once initialized, a timer task is started which periodically
+ * checks the target file for updates. If the file has been modified, it is read
+ * and cleared. The read data is transmitted to the CAD Simulator.
  *
  * @author Matthew Cechini
- * @version
+ * @version 0.1 Notes by jdalbey: Paramics modeler is licensed third-party
+ * software and apparently we don't have an SDK for it. So it seems the
+ * workaround was to communicate with it via data files that the modeler
+ * produces. Wacky, but it works for now. Look at the run() method below: if
+ * (lastModified < inputFile.lastModified()) Means it's watching the file to
+ * see if it has been updated by the modeler.
  */
-public class ParamicsFileReader extends Observable {
-    
-    /** Error Logger. */
-    private Logger paramLogger = Logger.getLogger("tmcsim.paramicscommunicator");   
-    
-    /** FileReader ID used for creation of the ParamicsCommMessage */
+public class ParamicsFileReader extends Observable
+{
+
+    /**
+     * Error Logger.
+     */
+    private Logger paramLogger = Logger.getLogger("tmcsim.paramicscommunicator");
+    /**
+     * FileReader ID used for creation of the ParamicsCommMessage
+     */
     private String readerID = null;
-    
-    /** File reference to the file where data is read. */
+    /**
+     * File reference to the file where data is read.
+     */
     private File inputFile = null;
-    
-    /** FileReader used to read data from the input file. */
+    /**
+     * FileReader used to read data from the input file.
+     */
     private FileReader fileReader = null;
-    
-    /** FileWriter used to clear the input file. */
+    /**
+     * FileWriter used to clear the input file.
+     */
     private FileWriter fileWriter = null;
-    
-    /** Value (seconds since 1/1/1970) of input file's last modification time. */
+    /**
+     * Value (seconds since 1/1/1970) of input file's last modification time.
+     */
     private long lastModified = 0;
-    
-    /** Timer used to schedule file reading tasks. */
+    /**
+     * Timer used to schedule file reading tasks.
+     */
     private Timer readerTimer = null;
-    
-    /** 
-     * Duration (in seconds) that the TimerTask will be scheduled to
-     * read from the target file.
+    /**
+     * Duration (in seconds) that the TimerTask will be scheduled to read from
+     * the target file.
      */
     private long readerInterval;
-    
+
     /**
-     * A TimerTask to read from the target file.  If the file has been modified since
-     * last read, read the file and transmit the data to the CAD Simulator.
+     * A TimerTask to read from the target file. If the file has been modified
+     * since last read, read the file and transmit the data to the CAD
+     * Simulator.
+     *
      * @author Matthew Cechini
      */
-    private class ReaderTimerTask extends TimerTask {
-        public void run() {     
-            
-            if (lastModified < inputFile.lastModified()) {
-                                
-                try {
+    private class ReaderTimerTask extends TimerTask
+    {
+
+        public void run()
+        {
+
+            if (lastModified < inputFile.lastModified())
+            {
+
+                try
+                {
                     Document readerDoc = DocumentBuilderFactory.newInstance()
-                        .newDocumentBuilder().newDocument();
-            
+                            .newDocumentBuilder().newDocument();
+
                     Element readerElem = readerDoc.createElement(PARAMICS_COMM_TAGS.READER.tag);
                     readerElem.setAttribute(PARAMICS_COMM_TAGS.ID.tag, readerID);
-                    readerElem.setAttribute(PARAMICS_COMM_TAGS.ACTION.tag, 
+                    readerElem.setAttribute(PARAMICS_COMM_TAGS.ACTION.tag,
                             PARAMICS_ACTIONS.READ_FILE.action);
-                    
+
                     Element messageElem = readerDoc.createElement(PARAMICS_COMM_TAGS.MESSAGE.tag);
-                    messageElem.appendChild(readerDoc.createTextNode(readFromFile()));
+                    String fileContents = readFromFile();
+                    messageElem.appendChild(readerDoc.createTextNode(fileContents));
                     readerElem.appendChild(messageElem);
-                    
-                    readerDoc.appendChild(readerElem);          
-                        
+
+                    readerDoc.appendChild(readerElem);
+
                     setChanged();
                     notifyObservers(readerDoc);
-                }                   
-                catch (Exception e) {
-                    paramLogger.logp(Level.SEVERE, 
-                            "ParamicsFileReader.ReaderTimerTask", "run()", 
-                            "Exception in reading from file: " + 
-                            inputFile.getName(), e);
+                } catch (Exception e)
+                {
+                    paramLogger.logp(Level.SEVERE,
+                            "ParamicsFileReader.ReaderTimerTask", "run()",
+                            "Exception in reading from file: "
+                            + inputFile.getName(), e);
                 }
             }
@@ -98 +114 @@
     }
 
-
     /**
-     * Constructor.  Set the reader id and interval from the parsed
-     * ParamicsCommMessage.  The interval is found within the first three
-     * characters of the object's "message" data member.  Create a file
-     * object for the target file, and create a new file if it does
-     * not already exist.  Instantiate the timer and ReaderTimerTask
-     * to begin periodic reading of the file.
-     * 
-     * @param workingDir Target working directory.
+     * Constructor. Set the reader id and interval from the parsed
+     * ParamicsCommMessage. The interval is found within the first three
+     * characters of the object's "message" data member. Create a file object
+     * for the target file, and create a new file if it does not already exist.
+     * Instantiate the timer and ReaderTimerTask to begin periodic reading of
+     * the file.
+     *
+     * @param workingDir Target working directory. // Oops, the following seem
+     * obsolete
      * @param mess ParamicsCommMessage object containing registration data.
      * @param theComm Reference to the ParamicsCommunicator.
      */
-    public ParamicsFileReader(String workingDir, String id, Integer interval, String targetFile) {
-        
-        try {       
-            readerID       = id;
+    public ParamicsFileReader(String workingDir, String id, Integer interval, String targetFile)
+    {
+
+        try
+        {
+            readerID = id;
             readerInterval = interval;
-                    
-            inputFile = new File(workingDir + targetFile);  
-                        
-            if(!inputFile.exists()) {
+
+            inputFile = new File(workingDir + targetFile);
+
+            if (!inputFile.exists())
+            {
                 inputFile.createNewFile();
             }
-            
+
             readerTimer = new Timer();
-            readerTimer.scheduleAtFixedRate(new ReaderTimerTask(), 
-                0L, readerInterval * 1000); 
-            
-        } catch (IOException ioe) {
-            paramLogger.logp(Level.SEVERE, "ParamicsFileReader", 
+            readerTimer.scheduleAtFixedRate(new ReaderTimerTask(),
+                    0L, readerInterval * 1000);
+
+        } catch (IOException ioe)
+        {
+            paramLogger.logp(Level.SEVERE, "ParamicsFileReader",
                     "Constructor()", "Exception in initializing file reading.", ioe);
         }
     }
-    
-    
+
     /**
-     * Method opens the target file and reads all contents.  The file is then 
+     * Method opens the target file and reads all contents. The file is then
      * cleared.
      *
      * @returns
-     * @throws IOException if there is an error in reading or writing to the file.
+     * @throws IOException if there is an error in reading or writing to the
+     * file.
      */
-    private String readFromFile() throws IOException {
-        
-        char[] input = new char[(int)inputFile.length()];
-        
+    private String readFromFile() throws IOException
+    {
+
+        char[] input = new char[(int) inputFile.length()];
+
         fileReader = new FileReader(inputFile);
-        fileReader.read(input);     
+        fileReader.read(input);
         fileReader.close();
-        
+
         //make sure the new file has a modified time that is different
-        try {
+        try
+        {
             Thread.sleep(1000);
+        } catch (Exception e)
+        {
         }
-        catch (Exception e) {}
-        
+
         //clear file after reading contents
         fileWriter = new FileWriter(inputFile);
         fileWriter.write("");
         fileWriter.close();
-        
+
         lastModified = inputFile.lastModified();
-        
+
         setChanged();
-        notifyObservers(new FileIOUpdate(IO_TYPE.READ, readerID, (long)input.length));      
-                        
+        notifyObservers(new FileIOUpdate(IO_TYPE.READ, readerID, (long) input.length));
+
         return new String(input);
-    }       
+    }
 }

trunk/src/tmcsim/paramicscommunicator/gui/ParamicsCommunicatorGUI.java

@@ -11 +11 @@
 import java.util.logging.LogRecord;
 import java.util.logging.Logger;
-
 import javax.swing.BorderFactory;
 import javax.swing.Box;
 import javax.swing.BoxLayout;
 import javax.swing.JFrame;
+import javax.swing.JMenuBar;
+import javax.swing.JOptionPane;
 import javax.swing.JScrollPane;
 import javax.swing.JTabbedPane;
 import javax.swing.JTextArea;
-
+import tmcsim.common.RevisionNumber;
 import tmcsim.paramicscommunicator.FileIOUpdate;
 import tmcsim.paramicscommunicator.FileRegUpdate;
 
 /**
- * ParamicsCommunicatorGUI is the view class for the ParamicsCommunicator.
- * The user interface shows a tab for each I/O reader or writer that has
- * been registered with the ParamicsCommunicator.  The tab shows the 
- * history of I/O reads and writes, and the unique information for the
- * target file and I/O interval.
- * 
+ * ParamicsCommunicatorGUI is the view class for the ParamicsCommunicator. The
+ * user interface shows a tab for each I/O reader or writer that has been
+ * registered with the ParamicsCommunicator. The tab shows the history of I/O
+ * reads and writes, and the unique information for the target file and I/O
+ * interval.
+ *
  * @author Matthew Cechini
  * @version
  */
 @SuppressWarnings("serial")
-public class ParamicsCommunicatorGUI extends JFrame implements Observer {
-    
-    /**
-     * Logging handler that writes all received log records to the
-     * error text area.
+public class ParamicsCommunicatorGUI extends JFrame implements Observer
+{
+
+    /**
+     * Logging handler that writes all received log records to the error text
+     * area.
+     *
      * @author Matthew Cechini
      */
-    protected class ParamicsLoggerHandler extends Handler {
+    protected class ParamicsLoggerHandler extends Handler
+    {
 
         DateFormat timeFormat = DateFormat.getTimeInstance();
-        
-        public void close() throws SecurityException {
-        }
-        
-        public void flush() {
-        }
-        
-        public void publish(LogRecord record) {
+
+        public void close() throws SecurityException
+        {
+        }
+
+        public void flush()
+        {
+        }
+
+        public void publish(LogRecord record)
+        {
             StringBuffer errorBuf = new StringBuffer();
-            
+
             errorBuf.append(timeFormat.format(new Date(record.getMillis())));
-            errorBuf.append("  -  " + record.getMessage() + "\n");          
-            
-            errorTA.setText(errorTA.getText() + errorBuf.toString()); 
-        }       
-    }
-
-    /** Map of FileIOTableModel objects for each reader id. */
+            errorBuf.append("  -  " + record.getMessage() + "\n");
+
+            errorTA.setText(errorTA.getText() + errorBuf.toString());
+        }
+    }
+    /**
+     * Map of FileIOTableModel objects for each reader id.
+     */
     protected TreeMap<String, FileIOTableModel> readerTables;
-
-    /** Map of FileIOTableModel objects for each writer id. */
+    /**
+     * Map of FileIOTableModel objects for each writer id.
+     */
     protected TreeMap<String, FileIOTableModel> writerTables;
-    
-    /**
-     * Constructor.  Initialize local lists, set up the logging handler and
+
+    /**
+     * Constructor. Initialize local lists, set up the logging handler and
      * initialize the GUI.
      */
-    public ParamicsCommunicatorGUI() {      
+    public ParamicsCommunicatorGUI()
+    {
         super("Paramics Communicator");
-        
+
         readerTables = new TreeMap<String, FileIOTableModel>();
         writerTables = new TreeMap<String, FileIOTableModel>();
-        
+
         Logger.getLogger("tmcsim.paramicscommunicator").addHandler(new ParamicsLoggerHandler());
-        
+
         initializeGUI();
-    }   
-    
-    /**
-     * Observer update method.  If the update object is a FileIOUpdate object,
-     * update the TableModel corresponding to the unique I/O id.  If the
-     * update object is a FileRegUpdate object, add a new tab if the 
-     * registration type is REGISTER, or update an existing tab if the
-     * registration type is UNREGISTER.
-     */
-    public void update(Observable o, Object arg) {
-        
-        if(arg instanceof FileIOUpdate) {
-
-            try {
-                FileIOUpdate update = (FileIOUpdate)arg;
-                
-                switch(update.ioType) {
+    }
+
+    /**
+     * Observer update method. If the update object is a FileIOUpdate object,
+     * update the TableModel corresponding to the unique I/O id. If the update
+     * object is a FileRegUpdate object, add a new tab if the registration type
+     * is REGISTER, or update an existing tab if the registration type is
+     * UNREGISTER.
+     */
+    public void update(Observable o, Object arg)
+    {
+
+        if (arg instanceof FileIOUpdate)
+        {
+
+            try
+            {
+                FileIOUpdate update = (FileIOUpdate) arg;
+
+                switch (update.ioType)
+                {
                     case READ:
                         readerTables.get(update.ioID).addIOUpdate(update);
@@ -104 +118 @@
                         break;
                 }
-            }
-            catch (Exception e) {
+            } catch (Exception e)
+            {
                 Logger.getLogger("tmcsim.paramicscommunicator.gui").logp(
-                        Level.SEVERE, "ParamicsCommunicatorGUI", "update", 
+                        Level.SEVERE, "ParamicsCommunicatorGUI", "update",
                         "Exception in receiving FileIOUpdate object.", e);
             }
-        }
-        else if(arg instanceof FileRegUpdate) {
-            try {
-                FileRegUpdate update = (FileRegUpdate)arg;
-                
-                switch(update.ioType) {
+        } else if (arg instanceof FileRegUpdate)
+        {
+            try
+            {
+                FileRegUpdate update = (FileRegUpdate) arg;
+
+                switch (update.ioType)
+                {
                     case READ:
-                        switch(update.regType) {
+                        switch (update.regType)
+                        {
                             case REGISTER:
                                 FileIOTableModel model = new FileIOTableModel();
                                 readerTables.put(update.ioID, model);
-    
+
                                 addTab(update, model);
                                 break;
@@ -130 +147 @@
                         break;
                     case WRITE:
-                        switch(update.regType) {
+                        switch (update.regType)
+                        {
                             case REGISTER:
                                 FileIOTableModel model = new FileIOTableModel();
                                 writerTables.put(update.ioID, model);
-                                
+
                                 addTab(update, model);
                                 break;
@@ -140 +158 @@
                                 //unregister
                                 break;
-                        }                   
+                        }
                         break;
                 }
 
-            }
-            catch (Exception e) {
+            } catch (Exception e)
+            {
                 Logger.getLogger("tmcsim.paramicscommunicator.gui").logp(
-                        Level.SEVERE, "ParamicsCommunicatorGUI", "update", 
+                        Level.SEVERE, "ParamicsCommunicatorGUI", "update",
                         "Exception in receiving FileRegUpdate object.", e);
             }
-        }       
-    }
-    
-    private void initializeGUI() {
-        
-        /* Added by Nathaniel Lehrer */
-        this.setJMenuBar(new javax.swing.JMenuBar() {
-            {
-                javax.swing.JMenu fileMenu = new javax.swing.JMenu("File");
-                javax.swing.JMenuItem logItem = new javax.swing.JMenuItem("Show Log");
-                
-                logItem.addActionListener(new java.awt.event.ActionListener() {
-                    public void actionPerformed(java.awt.event.ActionEvent evt) {
-                        tmcsim.paramicslog.gui.ParamicsLogGUI.getInstance().display(); 
-                    }
-                });
-                
-                fileMenu.add(logItem);
-                this.add(fileMenu);
+        }
+    }
+
+    private void initializeGUI()
+    {
+
+        JMenuBar menuBar = new JMenuBar();
+
+        javax.swing.JMenu fileMenu = new javax.swing.JMenu("File");
+        javax.swing.JMenuItem logItem = new javax.swing.JMenuItem("Show Log");
+
+        logItem.addActionListener(new java.awt.event.ActionListener()
+        {
+            public void actionPerformed(java.awt.event.ActionEvent evt)
+            {
+                tmcsim.paramicslog.gui.ParamicsLogGUI.getInstance().display();
             }
         });
-        /* End Add by Nathaniel Lehrer */
-        
+
+        fileMenu.add(logItem);
+        menuBar.add(fileMenu);
+
+        javax.swing.JMenu helpMenu = new javax.swing.JMenu("Help");
+        javax.swing.JMenuItem aboutItem = new javax.swing.JMenuItem("About");
+
+        aboutItem.addActionListener(new java.awt.event.ActionListener()
+        {
+            public void actionPerformed(java.awt.event.ActionEvent evt)
+            {
+                String ver = RevisionNumber.getString();
+                JOptionPane.showMessageDialog(rootPane, "Version: " + ver, "About", JOptionPane.INFORMATION_MESSAGE);
+            }
+        });
+
+        helpMenu.add(aboutItem);
+        menuBar.add(helpMenu);
+
+        this.setJMenuBar(menuBar);
+
         fileIOTabs = new JTabbedPane();
         fileIOTabs.setAlignmentX(Box.CENTER_ALIGNMENT);
@@ -180 +214 @@
         fileIOTabs.setBorder(BorderFactory.createCompoundBorder(
                 BorderFactory.createTitledBorder(
-                    BorderFactory.createRaisedBevelBorder(), "Registered I/O"),
-                    BorderFactory.createEmptyBorder(5,5,5,5)));
-    
+                BorderFactory.createRaisedBevelBorder(), "Registered I/O"),
+                BorderFactory.createEmptyBorder(5, 5, 5, 5)));
+
         errorTA = new JTextArea();
         errorTA.setLineWrap(true);
-        
+
         errorPane = new JScrollPane();
         errorPane.setViewportView(errorTA);
@@ -191 +225 @@
         errorPane.setBorder(BorderFactory.createCompoundBorder(
                 BorderFactory.createTitledBorder(
-                    BorderFactory.createRaisedBevelBorder(), "Errors"),
-                    BorderFactory.createEmptyBorder(5,5,5,5)));
-        
-        
+                BorderFactory.createRaisedBevelBorder(), "Errors"),
+                BorderFactory.createEmptyBorder(5, 5, 5, 5)));
+
+
         Box guiBox = new Box(BoxLayout.Y_AXIS);
         guiBox.add(fileIOTabs);
         guiBox.add(Box.createVerticalStrut(10));
         guiBox.add(errorPane);
-        
+
         add(guiBox);
-        
+
         setMinimumSize(new Dimension(420, 680));
         setPreferredSize(new Dimension(420, 680));
@@ -208 +242 @@
         setVisible(true);
     }
-    
-    /**
-     * Method creates a new tab for the new I/O object.  The tab is labeled
+
+    /**
+     * Method creates a new tab for the new I/O object. The tab is labeled
      * "Reader #" or "Writer #", where '#' is the I/O object's ID.
+     *
      * @param update Initial update object.
-     * @param model TableModel for reader/writer that will display I/O operations.
-     */
-    private void addTab(FileRegUpdate update, FileIOTableModel model) {
-        
+     * @param model TableModel for reader/writer that will display I/O
+     * operations.
+     */
+    private void addTab(FileRegUpdate update, FileIOTableModel model)
+    {
+
         String tabName = null;
-        
-        switch(update.ioType) {
+
+        switch (update.ioType)
+        {
             case READ:
                 tabName = "Reader " + update.ioID;
@@ -227 +265 @@
                 break;
         }
-        
+
         fileIOTabs.add(tabName, new ParamicsIOInfoPanel(update, model));
     }
-    
     private JTabbedPane fileIOTabs;
-
     private JScrollPane errorPane;
-    
     private JTextArea errorTA;
-
 }