1
+2
+3
+5
+4
+1
+| Observer Message Type |
+ * Command Message Type |
+ * Data Content |
+ *
|---|---|---|
| SCREEN_UPDATE |
+ * UPDATE_STATUS | + *Screen update map String. | + *
| TIME_UPDATE |
+ * UPDATE_TIME | + *CAD time String. (HHMM) | + *
| ROUTED_MESSAGE |
+ * UPDATE_MSG_COUNT | + *Number of messages. | + *
| UPDATE_MSG_UNREAD | + *Boolean flag to designate unread messages. | + *|
| CAD_INFO_MESSAGE |
+ * CAD_INFO | + *+ * |
| REFRESH_VIEW |
+ * UPDATE_SCREEN | + *Current CAD model XML data. | + *
+ * -----------
+ * TERMINAL_REGISTER
+ *
+ * The CAD position and user ID are parsed from the Element and these
+ * values are sent to the CADScreenManager for use.
+ * -----------
+ * SAVE_COMMAND_LINE
+ *
+ * The current command line text is parsed from the Element and sent
+ * to the CADScreenManager for user.
+ *
+ * -----------
+ * TERMINAL_CMD_LINE
+ * The CAD command is parsed from the Element and converted to a
+ * CAD_CLIENT_CMD enumeration that is used to call the correct
+ * method in the CADScreenManager to perform the command.
+ *
+ * -----------
+ * TERMINAL_FUNCTION
+ *
+ * The key value is parsed from the Element and converted to a CAD_KEYS
+ * enumeration that is sent to the CADScreenManager to perform the
+ * associated action.
+ *
+ * -----------
+ * TERMINATE
+ *
+ *
+ * -----------
+ *
+ * @param receivedData String of data received on the socket.
+ *
+ * @see CADProtocol
+ */
+ private void receiveObject(Object rxData) throws IOException {
+
+ try {
+
+ Element root = ((Document)rxData).getDocumentElement();
+
+ switch(CAD_CLIENT_CMD.fromString(root.getNodeName())) {
+
+ case TERMINAL_REGISTER:
+ Node positionNode = root.getChildNodes().item(0);
+ screenManager.setCADPosition(Integer.parseInt(positionNode.getTextContent()));
+
+ Node userIDNode = root.getChildNodes().item(1);
+ screenManager.setCADUserID(userIDNode.getTextContent());
+ break;
+
+ case SAVE_COMMAND_LINE:
+ screenManager.receiveCommandLine(root.getTextContent());
+ break;
+ case TERMINAL_CMD_LINE:
+
+ Node commandNode = root.getChildNodes().item(0);
+
+ switch(CAD_COMMANDS.fromFullName(commandNode.getNodeName())) {
+ case INCIDENT_BOARD:
+ screenManager.incidentBoardRequest((Element)commandNode);
+ break;
+ case INCIDENT_UPDATE:
+ screenManager.incidentUpdateRequest((Element)commandNode);
+ break;
+ case INCIDENT_INQUIRY:
+ screenManager.incidentInquiryRequest((Element)commandNode);
+ break;
+ case INCIDENT_SUMMARY:
+ screenManager.incidentSummaryRequest((Element)commandNode);
+ break;
+ case ROUTED_MESSAGE:
+ screenManager.routedMessageRequest((Element)commandNode);
+ break;
+ case ENTER_INCIDENT:
+ screenManager.enterIncidentRequest((Element)commandNode);
+ break;
+ case TERMINAL_OFF:
+ screenManager.terminalOffRequest();
+ break;
+ case APP_CLOSE:
+
+ try {
+ Document cmdDoc = DocumentBuilderFactory.newInstance()
+ .newDocumentBuilder().newDocument();
+ cmdDoc.appendChild(cmdDoc.createElement(CAD_SIMULATOR_CMD.
+ APP_CLOSE.type)); transmitCommand(cmdDoc);
+
+ } catch (Exception e) {
+ cadLogger.logp(Level.SEVERE, "CADSimulatorClient", "update",
+ "Error in transmitting a command to client.", e);
+ }
+
+ //disconnectClient();
+ break;
+ case UNKNOWN:
+ //TODO
+ break;
+ }
+ break;
+
+ case TERMINAL_FUNCTION:
+ screenManager.receiveCommand(CAD_KEYS.fromValue(
+ root.getTextContent().substring(
+ 0, root.getTextContent().indexOf(":")),
+ new Integer(root.getTextContent().substring(
+ root.getTextContent().indexOf(":") + 1))));
+ break;
+ }
+ }
+ catch (ClassCastException cce) {
+ cadLogger.logp(Level.SEVERE, "CADSimulatorClient",
+ "receiveObject",
+ "Incorrect object received from client.", cce);
+ }
+ }
+
+ /**
+ * This method transmits the Document command message to the remote
+ * CAD Client. If an exception occurs in writing to the socket, an
+ * Exception is thrown and socket communication is closed.
+ *
+ * @param data The data being transmitted
+ * @throws IOException if there is an exception in writing to the socket.
+ */
+ private void transmitCommand(Document data) throws IOException {
+
+ try {
+ out.writeObject(data);
+ out.flush();
+ } catch (IOException ioe) {
+ cadLogger.logp(Level.SEVERE, "CADSimulatorClient",
+ "transmitCommand", "Error writing to Client socket: " +
+ theSocket.getInetAddress() + ", dropping connection.", ioe);
+
+ //disconnectClient();
+ }
+
+ }
+}
Index: trunk/src/tmcsim/cadsimulator/CADSimulator.java
===================================================================
--- trunk/src/tmcsim/cadsimulator/CADSimulator.java (revision 2)
+++ trunk/src/tmcsim/cadsimulator/CADSimulator.java (revision 2)
@@ -0,0 +1,357 @@
+package tmcsim.cadsimulator;
+
+import java.awt.event.WindowEvent;
+import java.awt.event.WindowListener;
+import java.io.File;
+import java.io.FileInputStream;
+import java.rmi.Naming;
+import java.rmi.RemoteException;
+import java.rmi.registry.LocateRegistry;
+import java.util.Calendar;
+import java.util.Properties;
+import java.util.logging.FileHandler;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+import javax.swing.JOptionPane;
+import javax.swing.JWindow;
+import javax.swing.UIManager;
+import javax.xml.parsers.DocumentBuilderFactory;
+
+import tmcsim.cadsimulator.db.CMSDiversionDB;
+import tmcsim.cadsimulator.managers.ATMSManager;
+import tmcsim.cadsimulator.managers.IncidentManager;
+import tmcsim.cadsimulator.managers.MediaManager;
+import tmcsim.cadsimulator.managers.ParamicsSimulationManager;
+import tmcsim.cadsimulator.managers.SimulationControlManager;
+import tmcsim.cadsimulator.viewer.CADSimulatorViewer;
+import tmcsim.client.cadclientgui.data.CADData;
+import tmcsim.common.SimulationException;
+import tmcsim.simulationmanager.SimulationManager;
+
+
+/**
+ * CADSimulator is main class for the CAD Simulator application. 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 instances of all Manager Objects that are used
+ * to control the Simulation flow of data.
+ * -----------------------------------------------------------------------------
+ * CADClientPort The port number to use for remote CAD Client connections.
+ * CoordinatorRMIPort The port number to use for binding the Coordinator.
+ * 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.
+ * ParamicsProperties The filepath for the properties file to initialize the ParamicsControlManager.
+ * ATMSProperties The filepath for the properties file to initialize the ATMSManager.
+ * MediaProperties The filepath for the properties file to initialize the MediaManager.
+ * ErrorFile The filename of the error file used for logging errors.
+ * ----------------------------------------------------------------------------
+ * Example File:
+ * CADClientPort = 4444
+ * CoordinatorRMIPort = 4445
+ * CMSDiversionXML = ../data/cmsdiversions.xml
+ * AudioFileLocation = ../audio/
+ * ParamicsProperties = ../config/paramics.properties
+ * ATMSProperties = ../config/atms.properties
+ * MediaProperties = ../config/media.properties
+ * ErrorFile = cad_sim_error.xml
+ *
+ *
+ * @author Matthew Cechini (mcechini@calpoly.edu)
+ * @version $Date: 2009/04/17 16:27:46 $ $Revision: 1.5 $
+ */
+public class CADSimulator {
+
+ /** Error logger. */
+ private static Logger cadSimLogger = Logger.getLogger("tmcsim.simulationmanager");
+
+ /**
+ * Enumeration containing properties name values. See CADSimulator class
+ * description for more information.
+ * @author Matthew
+ * @see CADSimulator
+ */
+ private static enum CAD_PROPERTIES {
+ /** RMI port to accept CAD Client connections. */
+ CLIENT_PORT ("CADClientPort"),
+ /** RMI port to bind the Coordinator to for RMI communication. */
+ COOR_RMI_PORT ("CoordinatorRMIPort"),
+
+ CAD_RMI_PORT ("CADRmiPort"),
+ /** Filepath for xml file containing diversion data. */
+ CMS_XML_FILE ("CMSDiversionXML"),
+ /** Filepath for xml file containing dvd control data. */
+ DVD_XML_FILE ("DVDPlayerXML"),
+ /** Filepath for xml file containing still image control data. */
+ IMAGE_XML_FILE ("StillImagesXML"),
+ /** Root directory path where audio files are referenced from. */
+ AUDIO_LOCATION ("AudioFileLocation"),
+ /** Filepath for the properties file to initialize the media manager. */
+ MEDIA_PROP_FILE ("MediaProperties"),
+ /** Filepath for the properties file to initialize the paramics control manager. */
+ PARAMICS_PROP_FILE ("ParamicsProperties"),
+ /** Filepath for the properties file to initialize the atms manager. */
+ ATMS_PROP_FILE ("ATMSProperties");
+
+ public String name;
+
+ private CAD_PROPERTIES(String n) {
+ name = n;
+ }
+ };
+
+
+ /** CADSimulatorViewer instance. */
+ protected static CADSimulatorViewer theViewer;
+
+ /** Coordinator instance. */
+ protected static Coordinator theCoordinator;
+
+ /** SoundPlayer instance. */
+ protected static SoundPlayer theSoundPlayer = null;
+
+ /** SimulationControlManager instance. */
+ protected static SimulationControlManager theSimulationCntrlMgr = null;
+
+ /** ParamicsSimulationManager instance. */
+ protected static ParamicsSimulationManager theParamicsSimMgr = null;
+
+ /** IncidentManager instance. */
+ protected static IncidentManager theIncidentMgr = null;
+
+ /** MediaManager instance. */
+ protected static MediaManager theMediaMgr = null;
+
+ /** ATMSManager instance. */
+ protected static ATMSManager theATMSMgr = null;
+
+ /** Properties file for the CADSimulator. */
+ private Properties cadSimulatorProperties;
+
+
+ /**
+ * Constructor. Load the Properties file and initialize all CAD Simulator
+ * Managers and establish Manager data relationships. A
+ * CADSimulatorSocketHandler is instantiated and started to being
+ * listening for remote CAD connections. The CMSDiversionDB is initialized
+ * with the XML data(incomplete design).
+ *
+ * @param propertiesFile Filename of CAD Simulator properties file.
+ * @throws SimulationException if there is an error in initializing the CAD Simulator.
+ */
+ public CADSimulator(String propertiesFile) throws SimulationException {
+
+ try {
+ cadSimulatorProperties = new Properties();
+ cadSimulatorProperties.load(new FileInputStream(propertiesFile));
+ }
+ catch (Exception e) {
+ cadSimLogger.logp(Level.SEVERE, "CADSimulator", "Constructor",
+ "Exception in reading properties file.", e);
+
+ throw new SimulationException(SimulationException.INITIALIZE_ERROR, e);
+ }
+
+ //Create the Coordinator and register it for RMI communicator. Start the
+ //CAD Simulator Socket Handler to begin to accept connections from CAD Clients.
+ try {
+ theViewer = new CADSimulatorViewer();
+ theCoordinator = new Coordinator();
+ startRegistry(Integer.parseInt(
+ cadSimulatorProperties.getProperty(
+ CAD_PROPERTIES.COOR_RMI_PORT.name).trim()));
+ startRegistry(Integer.parseInt(
+ cadSimulatorProperties.getProperty(
+ CAD_PROPERTIES.CAD_RMI_PORT.name).trim()));
+
+ theSimulationCntrlMgr = new SimulationControlManager(theCoordinator);
+
+ theATMSMgr = new ATMSManager(
+ cadSimulatorProperties.getProperty(
+ CAD_PROPERTIES.ATMS_PROP_FILE.name));
+
+ theMediaMgr = new MediaManager(
+ cadSimulatorProperties.getProperty(
+ CAD_PROPERTIES.MEDIA_PROP_FILE.name),
+ theATMSMgr, theViewer);
+
+ theParamicsSimMgr = new ParamicsSimulationManager(
+ cadSimulatorProperties.getProperty(
+ CAD_PROPERTIES.PARAMICS_PROP_FILE.name),
+ theCoordinator, theMediaMgr);
+
+ theSoundPlayer = new SoundPlayer(
+ cadSimulatorProperties.getProperty(
+ CAD_PROPERTIES.AUDIO_LOCATION.name));
+ theSoundPlayer.start();
+
+ theIncidentMgr = new IncidentManager(theCoordinator, theSoundPlayer);
+
+
+ //Begin accepting Client connections
+ CADSimulatorSocketHandler tmsh = new CADSimulatorSocketHandler(
+ Integer.parseInt(cadSimulatorProperties.getProperty(
+ CAD_PROPERTIES.CLIENT_PORT.name).trim()));
+ tmsh.start();
+ }
+ catch (RemoteException e) {
+ cadSimLogger.logp(Level.SEVERE, "CADSimulator", "Constructor",
+ "Exception in starting Coordinator.", e);
+
+ throw new SimulationException(SimulationException.BINDING, e);
+ }
+
+ //Load CMS Diversion Information from the XML file
+ try {
+ if(cadSimulatorProperties.getProperty(
+ CAD_PROPERTIES.CMS_XML_FILE.name) != null) {
+ CMSDiversionDB.getInstance().loadFromXML(
+ DocumentBuilderFactory.newInstance().newDocumentBuilder()
+ .parse(new File(cadSimulatorProperties.getProperty(
+ CAD_PROPERTIES.CMS_XML_FILE.name))));
+ }
+ }
+ catch (Exception e)
+ {
+ cadSimLogger.logp(Level.SEVERE, "CADSimulator", "Constructor",
+ "Exception in parsing CMSDiversion xml file.", e);
+
+ JOptionPane.showMessageDialog(new JWindow(), "Unable to open " +
+ cadSimulatorProperties.getProperty(CAD_PROPERTIES.CMS_XML_FILE.name),
+ "Initialization Error", JOptionPane.WARNING_MESSAGE);
+ }
+
+ theViewer.addWindowListener(new WindowListener() {
+ public void windowClosed(WindowEvent e) {}
+ public void windowOpened(WindowEvent e) {}
+ public void windowIconified(WindowEvent e) {}
+ public void windowDeiconified(WindowEvent e) {}
+ public void windowActivated(WindowEvent e) {}
+ public void windowDeactivated(WindowEvent e) {}
+ public void windowClosing(WindowEvent e) {
+ System.exit(0);
+ }
+ });
+
+ theViewer.setVisible(true);
+
+ }
+
+ /**
+ * Binds the Coordinator to an RMI port so that the SimulationManager
+ * can communicate with it, and so that the Coordinator can perform RMI
+ * callback method calls. The port numbers and RMI designators are parsed from
+ * the properties file file.
+ *
+ * @param theCoor A reference to the Coordinator object.
+ * @throws SimulationException if there are errors in binding the RMI to
+ * a port and name.
+ */
+ private void startRegistry(Integer regPort) throws SimulationException {
+
+ try{
+ LocateRegistry.createRegistry(regPort);
+
+ String registryURL = "rmi://localhost:" + regPort + "/coordinator";
+ Naming.rebind(registryURL, theCoordinator);
+ }
+ catch (Exception e) {
+ throw new SimulationException(SimulationException.BINDING, e);
+ }
+ }
+
+ /**
+ * Method returns a String represetnation of the current time. String format
+ * is HHMM
+ *
+ * @return String representation of the current time.
+ */
+ public static String getCADTime() {
+ String time = new String();
+
+ Calendar rightNow = Calendar.getInstance();
+
+ if(rightNow.get(Calendar.HOUR_OF_DAY) < 10)
+ time += "0";
+
+ time += (String.valueOf(rightNow.get(Calendar.HOUR_OF_DAY)));
+
+ if(rightNow.get(Calendar.MINUTE) < 10)
+ time += "0";
+
+ time += (String.valueOf(rightNow.get(Calendar.MINUTE)));
+
+ return time;
+ }
+
+ /**
+ * Returns a string representation of the current date. String format is:
+ * MMDDYY
+ *
+ * @return String format of the date.
+ */
+ public static String getCADDate() {
+ String date = new String();
+
+ Calendar rightNow = Calendar.getInstance();
+
+ //Months are zero referenced
+ if(rightNow.get(Calendar.MONTH) + 1 < 10)
+ date += "0";
+
+ date += (String.valueOf(rightNow.get(Calendar.MONTH)+ 1));
+
+ if(rightNow.get(Calendar.DAY_OF_MONTH) < 10)
+ date += "0";
+
+ date += (String.valueOf(rightNow.get(Calendar.DAY_OF_MONTH)));
+
+ if(rightNow.get(Calendar.YEAR) % 1000 < 10)
+ date += "0";
+
+ date += (String.valueOf(rightNow.get(Calendar.YEAR) % 1000));
+
+ return date;
+
+ }
+
+ /**
+ * Main class. Instantiate a CAD Simulator with the properties file
+ * specified on the command line or the default properties file
+ *
+ * @param args Command line arguments.
+ */
+ public static void main(String[] args) {
+ System.setProperty("CAD_SIM_PROPERTIES", "config/cad_simulator_config.properties");
+
+ try
+ {
+ if(System.getProperty("CAD_SIM_PROPERTIES") != null)
+ {
+ UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
+
+ new CADSimulator(System.getProperty("CAD_SIM_PROPERTIES"));
+ }
+ else
+ {
+ throw new Exception ("CAD_SIM_PROPERTIES system property not defined.");
+ }
+ }
+ catch (Exception e) {
+ cadSimLogger.logp(Level.SEVERE, "CADSimulator", "Main",
+ "Error initializing application.", e);
+
+ JOptionPane.showMessageDialog(new JWindow(), e.getMessage(),
+ "Error - Program Exiting", JOptionPane.ERROR_MESSAGE);
+
+ System.exit(-1);
+ }
+
+ }
+}
Index: trunk/src/tmcsim/cadsimulator/videocontrol/DVDStatusUpdate.java
===================================================================
--- trunk/src/tmcsim/cadsimulator/videocontrol/DVDStatusUpdate.java (revision 2)
+++ trunk/src/tmcsim/cadsimulator/videocontrol/DVDStatusUpdate.java (revision 2)
@@ -0,0 +1,56 @@
+package tmcsim.cadsimulator.videocontrol;
+
+/**
+ * DVDStatusUpdate is a container class used to notify observers of a DVD
+ * Controller when a status update occurs. The DVD's connection is used to
+ * uniquely identify a DVD player. So this connection information String should
+ * always be the same for all updates. The Abstract DVDController defines a
+ * getConnectionInfo() method that may be used for this purpise. The isConnected
+ * should also always be set. However, the Throwable object may be unused (null)
+ * if the DVDStatusUpdate is not reporting an exception. Otherwise, the Throwable
+ * will be the cause of the status update.
+ *
+ * @author Matthew Cechini
+ * @version
+ */
+public class DVDStatusUpdate {
+
+ /** DVD player connection info. */
+ public String connectionInfo = null;
+
+ /** Boolean flag to designate whether the DVD Controller is connected. */
+ public boolean isConnected = false;
+
+ /** An Exception that has been thrown from the DVD controller. (Optional) */
+ public Throwable exception = null;
+
+ /**
+ * Constructor.
+ *
+ * @param connInfo DVD connection info.
+ * @param connected Boolean connected flag.
+ * @param e Exception caught in DVD Controller.
+ */
+ public DVDStatusUpdate(String connInfo, boolean connected, Throwable e)
+ {
+ connectionInfo = connInfo;
+ isConnected = connected;
+ exception = e;
+
+ }
+
+ /**
+ * Constructor.
+ *
+ * @param connInfo DVD connection info.
+ * @param connected Boolean connected flag.
+ */
+ public DVDStatusUpdate(String connInfo, boolean connected)
+ {
+ connectionInfo = connInfo;
+ isConnected = connected;
+ exception = null;
+
+ }
+
+}
Index: trunk/src/tmcsim/cadsimulator/videocontrol/DVDRange.java
===================================================================
--- trunk/src/tmcsim/cadsimulator/videocontrol/DVDRange.java (revision 2)
+++ trunk/src/tmcsim/cadsimulator/videocontrol/DVDRange.java (revision 2)
@@ -0,0 +1,54 @@
+package tmcsim.cadsimulator.videocontrol;
+
+
+/**
+ * DVDRange is a container class used within video control. It contains a
+ * minimum and maximum speed range, an associated title number and duration for
+ * that title. The DVDController uses the DVDRange to determine
+ * which DVD title is to be played according to current traffic speed.
+ *
+ * @author Matthew Cechini
+ * @version
+ */
+public class DVDRange {
+
+ /** Minimum speed for this range. */
+ public float minSpeed;
+
+ /** Maximum speed for this range. */
+ public float maxSpeed;
+
+ /** DVD title to play for this range. */
+ public int dvdTitle;
+
+ /**
+ * Constructor. Initialize member data with parameter values.
+ *
+ * @param min Minimum speed in range.
+ * @param max Maximum speed in range.
+ * @param title Title to play for range.
+ * @param duration Length (in seconds) of range title.
+ */
+ public DVDRange(float min, float max, int title) {
+ minSpeed = min;
+ maxSpeed = max;
+ dvdTitle = title;
+ }
+
+ /**
+ * Tests if the parameter speed is >= the minimum speed and
+ * < the maximum speed for this range.
+ *
+ * @param speed Speed value to test for inclusion in range.
+ * @return True if the parameter is within the range, false if not.
+ */
+ public boolean isWithin(float speed) {
+ return speed >= minSpeed && speed < maxSpeed;
+ }
+
+ public boolean equals(DVDRange range) {
+ return dvdTitle == range.dvdTitle &&
+ minSpeed == range.minSpeed &&
+ maxSpeed == range.maxSpeed;
+ }
+}
Index: trunk/src/tmcsim/cadsimulator/videocontrol/DVDIncident.java
===================================================================
--- trunk/src/tmcsim/cadsimulator/videocontrol/DVDIncident.java (revision 2)
+++ trunk/src/tmcsim/cadsimulator/videocontrol/DVDIncident.java (revision 2)
@@ -0,0 +1,30 @@
+package tmcsim.cadsimulator.videocontrol;
+
+/**
+ * DVDIncident is a container class used within video control. This class is
+ * used by the DVDController to determine which DVD title is to be played
+ * when an incident is toggled.
+ *
+ * @author Matthew Cechini
+ * @version
+ */
+public class DVDIncident {
+
+ /** The incident log number. */
+ public int incidentNumber;
+
+ /** The DVD title to play for this incident. */
+ public int dvdTitle;
+
+ /**
+ * Construct. Initialize member data with parameter values.
+ *
+ * @param incident Incident number.
+ * @param title DVD title number.
+ */
+ public DVDIncident(int incident, int title) {
+ incidentNumber = incident;
+ dvdTitle = title;
+ }
+
+}
Index: trunk/src/tmcsim/cadsimulator/videocontrol/PioneerV5000.java
===================================================================
--- trunk/src/tmcsim/cadsimulator/videocontrol/PioneerV5000.java (revision 2)
+++ trunk/src/tmcsim/cadsimulator/videocontrol/PioneerV5000.java (revision 2)
@@ -0,0 +1,450 @@
+package tmcsim.cadsimulator.videocontrol;
+
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.io.OutputStream;
+import java.net.InetSocketAddress;
+import java.net.Socket;
+
+
+/**
+ * DVDController extends from the Abstraact DVDController class to provide
+ * funtionality for controlling the Pioneer V5000 DVD Controller.
+ *
+ * @author Matthew Cechini (mcechini@calpoly.edu)
+ * @version $Date: 2006/06/15 19:08:15 $ $Revision: 1.5 $
+ */
+public class PioneerV5000 extends DVDController {
+
+ /**
+ * Enumeration of command strings used for DVD control.
+ * @author Matthew Cechini
+ */
+ protected static enum COMMAND_CHARS {
+ OPEN ("OP"),
+ CLOSE ("CO"),
+ START ("SA"),
+ SEARCH ("SE"),
+ PLAY ("PL"),
+ SEARCH_PLAY ("SL"),
+ PAUSE ("PA"),
+ STILL ("ST"),
+ REJECT ("RJ"),
+ SCAN_FWD ("NF"),
+ SCAN_RVS ("NR"),
+ SCAN_STOP ("NS"),
+ TITLE ("TI"),
+ CHAPTER ("CH"),
+ GROUP ("GP"),
+ CMD_STACK_PL ("BS"),
+ UPLOAD_DATA ("BD"), //Data from computer to player.
+ DOWNLOAD_DATA ("BU"), //Data from player to computer.
+ SETUP ("MS");
+
+ public String cmd;
+
+ private COMMAND_CHARS(String c) {
+ cmd = c;
+ }
+ }
+
+ /** Maximum number of command retries =5. */
+ protected final int MAX_RETRIES = 5;
+
+ /** Maximum command length = 32. */
+ protected final int MAX_COMMAND_LEN = 32;
+
+ /** Maximum response length = 32. */
+ protected final int MAX_RESPONSE_LEN = 32;
+
+ /** Carriage return character. */
+ protected final char CR = 0x0d;
+
+ /** Buffer for creating command string. */
+ protected StringBuffer commandString;
+
+ /** Buffer to receive repsonse string. */
+ protected StringBuffer responseString;
+
+ /** DVD Player host. */
+ protected String dvdHost = null;
+
+ /** DVD Player port. */
+ protected int dvdPort = 0;
+
+ /** Socket used for communication with DVD player. */
+ protected Socket serialInterfaceSocket = null;
+
+ /** IOStream for writing out commands. */
+ //protected ObjectOutputStream out = null;
+ protected OutputStream out = null;
+
+ /** IOStream for reading dvd player responses. */
+ protected BufferedReader in = null;
+
+
+ /**
+ * Constructor.
+ */
+ public PioneerV5000() {
+ commandString = new StringBuffer(MAX_COMMAND_LEN);
+ responseString = new StringBuffer(MAX_RESPONSE_LEN);
+ }
+
+ /**
+ * Sets the host and port connection information for this dvd player.
+ *
+ * @param host DVD player host string.
+ * @param port DVD player port value.
+ */
+ public void setConnectionInfo(String host, int port) {
+ dvdHost = host;
+ dvdPort = port;
+ }
+
+ /**
+ * Get the current connection information for this dvd player. The
+ * returned string is as follows: HOST:PORT
+ *
+ * @return DVD connection host:port
+ */
+ public String getConnectionInfo() {
+ return dvdHost + ":" + dvdPort;
+ }
+
+ public boolean isConnected() {
+ return isConnected;
+ }
+
+ /**
+ * Establish a connection with the dvd player through socket communication.
+ * If the port is successfully opened, input and ouput streams are opened
+ * on the socket. The isConnected boolean flag is set to true if this is
+ * successful. Observers are notified with a DVDStatusUpdate to show the
+ * new connection.
+ *
+ * @throws IOException if communication with the dvd player fails.
+ */
+ public void connect() throws IOException {
+
+ serialInterfaceSocket = new Socket();
+ serialInterfaceSocket.connect(new InetSocketAddress(dvdHost, dvdPort), 5000);
+ serialInterfaceSocket.setSoTimeout(5000);
+
+ //out = new ObjectOutputStream(serialInterfaceSocket.getOutputStream());
+ out = serialInterfaceSocket.getOutputStream();
+ in = new BufferedReader(new InputStreamReader(serialInterfaceSocket.getInputStream()));
+
+ isConnected = true;
+
+ setChanged();
+ notifyObservers(new DVDStatusUpdate(getConnectionInfo(),
+ isConnected()));
+ }
+
+
+ /**
+ * Disconnect from the dvd player. Close all IOStreams and socket, then set
+ * the isConnected flag to false. Observers are notified with a
+ * DVDStatusUpdate to show the loss of the connection.
+ */
+ public void disconnect() {
+
+ try {
+ in.close();
+ }
+ catch (Exception e) {}
+
+ try {
+ out.close();
+ }
+ catch (Exception e) {}
+
+ try {
+ serialInterfaceSocket.close();
+ }
+ catch (Exception e) {}
+
+
+ isConnected = false;
+
+ setChanged();
+ notifyObservers(new DVDStatusUpdate(getConnectionInfo(),
+ isConnected()));
+
+ }
+
+ /*
+ * If the command is sent while the player is in the Park mode, the dvd
+ * ejects and the player enters the Open mode. After the tray is ejected,
+ * player returns a completed status message.
+ *
+ * If the player is in any mode other than Open or Park, the disc stops, the
+ * player enters Open mode and the door opens.
+ *
+ * If the player is already in Open mode, an error message is returned.
+ */
+ public void open() throws IOException {
+ commandString.append(COMMAND_CHARS.OPEN.cmd);
+ transmit();
+ }
+
+
+ /*
+ * If the command is sent while the player door is open, the door
+ * closes then the player enters the Park mode. After the door closes, the
+ * player returns the completed status message.
+ *
+ * If the player is in any mode other than Open or if the player door is already
+ * closed, an error message is returned.
+ */
+ public void close() throws IOException {
+ commandString.append(COMMAND_CHARS.CLOSE.cmd);
+ transmit();
+ }
+
+ /*
+ * If the command is sent while the player is in Open, Park or Reject
+ * mode, the player immediately enters Setup and the disc begins spinning up.
+ * The player is ready for playback when the device reaches the beginning of
+ * the program (DVD, CD or VCD disc pauses or stills at the first Track). The
+ * player returns the completed status when the disc pauses or stills.
+ *
+ * If the player receives the command while playing a menu, the player returns
+ * an error message. However, if the disc program does not allow new
+ * commands once playback begins, the player ignores the command.
+ */
+ public void start() throws IOException {
+ commandString.append(COMMAND_CHARS.START.cmd);
+ transmit();
+ }
+
+ public void play() throws IOException {
+ commandString.append(COMMAND_CHARS.PLAY.cmd);
+ transmit();
+ }
+
+ public void playChapter(int chapter) throws IOException {
+ commandString.append(COMMAND_CHARS.CHAPTER.cmd + chapter);
+ commandString.append(COMMAND_CHARS.SEARCH_PLAY.cmd);
+ transmit();
+ }
+
+ public void playTitle(int title) throws IOException {
+ commandString.append(COMMAND_CHARS.TITLE.cmd + title);
+ commandString.append(COMMAND_CHARS.SEARCH_PLAY.cmd);
+ transmit();
+
+ }
+
+ public void repeatTitle(int title) throws IOException {
+ commandString.append(title + COMMAND_CHARS.GROUP.cmd);
+ commandString.append("1" + COMMAND_CHARS.CMD_STACK_PL.cmd);
+
+ transmit();
+ }
+
+
+ /*
+ * If the command is sent while the player is in Random Access
+ * mode, the pause occurs at the current disc location. The player returns the
+ * completed status message immediately.
+ *
+ * In Pause mode, Still and Video Squelch are ACTIVE. However, if the disc
+ * program does not allow a pause, the player ignores the command and
+ * returns an error message (E04).
+ */
+ public void pause() throws IOException {
+ commandString.append(COMMAND_CHARS.PAUSE.cmd);
+ transmit();
+ }
+
+ /*
+ * If the command is sent while the player is in Random Access
+ * mode, playback stops at the current disc position and the player enters Still
+ * mode. The player returns the completed status message immediately.
+ *
+ * However, if the disc program does not allow a pause, the player ignores the
+ * command and returns an error message (E04).
+ *
+ */
+ public void still() throws IOException {
+ commandString.append(COMMAND_CHARS.STILL.cmd);
+ transmit();
+ }
+
+ public void stepForward() throws IOException {}
+ public void stepReverse() throws IOException {}
+
+ /*
+ * If the command is sent while the player is in Random Access
+ * mode, the screen proceeds forward (NF) or in reverse (NR) quickly. When
+ * scanning is finished, the player resumes the Random Access mode and
+ * returns the completed status message.
+ *
+ * If the SCAN command is sent while the player is in Fast Forward or Reverse
+ * Playback, the player enters Scan mode.
+ *
+ * Once the NS command is sent, the player resets to the normal
+ *Playback mode and returns the completed status message.
+ */
+ public void scanForward() throws IOException {
+ commandString.append(COMMAND_CHARS.SCAN_FWD.cmd);
+ transmit();
+ }
+
+
+ public void scanReverse() throws IOException {
+ commandString.append(COMMAND_CHARS.SCAN_RVS.cmd);
+ transmit();
+ }
+
+
+ public void scanStop() throws IOException {
+ commandString.append(COMMAND_CHARS.SCAN_STOP.cmd);
+ transmit();
+ }
+
+ public void upload(String cmdStack) throws IOException {
+ //park mode
+ //out.write((COMMAND_CHARS.REJECT.cmd + CR).toString().getBytes());
+
+ //try { Thread.sleep(500); } catch (Exception e) {}
+
+ out.write((COMMAND_CHARS.UPLOAD_DATA.cmd + CR).toString().getBytes());
+ out.flush();
+
+ try { Thread.sleep(500); } catch (Exception e) {}
+
+ out.write((cmdStack + CR).toString().getBytes());
+ out.flush();
+
+
+ }
+
+ public String download() throws Exception {
+ //park mode
+ commandString.append(COMMAND_CHARS.REJECT.cmd + CR);
+ transmit();
+
+ commandString.append(COMMAND_CHARS.DOWNLOAD_DATA.cmd + CR);
+
+ //send carriage return to refresh the connection
+ //out.writeChar(CR);
+ out.write(CR);
+ out.flush();
+
+ //clear response buffer
+ while(in.ready())
+ responseString.append(in.readLine());
+ responseString.setLength(0);
+
+ //send the command
+ //out.writeBytes(commandString.toString());
+ out.write(commandString.toString().getBytes());
+ out.flush();
+
+ //read in response
+ while(in.ready())
+ responseString.append(in.readLine());
+
+
+ if(responseString.indexOf("E") == 0) {
+ throw new Exception("Error in downloading from player.");
+ }
+ else {
+ return responseString.toString();
+ }
+
+ }
+
+ /**
+ * This method spawns a thread to transmit the current command found in the
+ * commandString buffer to the DVD player. If the output stream is null,
+ * observers are notified with a DVDStatusUpdate containing the exception.
+ * The following steps are taken to transmit the command: | Status |
+ * Actions Taken |
+ *
|---|---|
| NO_SCRIPT |
+ * Set the simulation status text to a black "No Script". |
+ *
| SCRIPT_STOPPED_NOT_STARTED |
+ * Set the simulation status text to a red "Ready". |
+ *
| SCRIPT_PAUSED_STARTED |
+ * Set the simulation status text to a red "Paused". |
+ *
| SCRIPT_RUNNING |
+ * Set the simulation status text to a green "Running". |
+ *
| ATMS_SYNCHRONIZATION |
+ * Set the simulation status text to an orange "Synchronizing". |
+ *
| CAD Protocol Command |
+ * Action Taken |
+ *
|---|---|
| CYCLE | + *Set the currentCADScreenNum to the next screen number, set the screen update + * value to false, update the current model, and notify observers to refresh the view. + * | + *
| REFRESH | + *Set the screen update value to false, update the current model, + * and notify observers to refresh the view. | + *
| NEXT_QUEUE | + *If this terminal has not received any messages, do nothing. If + * messages have been received, and the current CADScreen is + * showing the TO_ROUTED_MESSAGE screen, then call the model's + * nextQueue() method and notify observers to refresh their view. + * If messages have been received, but the current screen is not + * showing a routed message, then set the current cad screen model + * to the RoutedMessageModel with the received list of messages and + * notify observers. Update the message map to show that the + * message has been viewd. Update the unreadMessages flag to + * designate whether unread messages still exist for this CAD + * position. Notify observers with the updated routed message info. | + *
| DELETE_QUEUE |
+ * If this terminal has not received any messages, do nothing. + * If the current CADScreen is showing a routed message, get the + * current message. Remove this message from the current message map. + * Also remove the message from all RoutedMessageModels that are + * being shown in a CAD Screen by calling the deleteQueue() method. + * Notify observers to refresh their view. + * | + *
| PREV_QUEUE |
+ * If this terminal has not received any messages, do nothing. + * If messages have been received, and the current CADScreen is + * showing the TO_ROUTED_MESSAGE screen, then call the model's + * prevQueue() method and notify observers to refresh their view. + * If messages have been received, but the current screen is not + * showing a routed message, then set the current cad screen model + * to the RoutedMessageModel with the received list of messages and + * notify observers. Update the message map to show that the + * message has been viewd. Update the unreadMessages flag to + * designate whether unread messages still exist for this CAD + * position. Notify observers with the updated routed message info. + * | + *
| SCREEN_CLEAR |
+ * Set the current model to the BlankScreenModel and notify observers + * to refresh the view. | + *
+ * -----------------------------------------------------------------------------
+ * Host Name The host name where the CAD Simulator is located.
+ * Port Number The port number that the CAD Simulator is bound on.
+ * CAD Position The integer (>= 0) position for this CAD Client.
+ * CAD User ID The unique user id for this CAD Client.
+ * Error File Filename of error logging file.
+ * -----------------------------------------------------------------------------
+ * Example File:
+ * CADSimulatorHost = localhost
+ * CADSimulatorSocketPort = 4444
+ * CADPosition = 1
+ * CADUserID = A12345
+ * ErrorFile = cad_client_err.txt
+ *
+ *
+ * @author Matthew Cechini (mcechini@calpoly.edu)
+ * @version $Date: 2009/04/17 16:27:47 $ $Revision: 1.8 $
+ */
+/*Hai :3 yeeeee*/
+public class CADClient extends UnicastRemoteObject implements
+ CADClientInterface {
+
+ /** Error logger. */
+ private static Logger cadClientLogger = Logger.getLogger("tmcsim.client");
+
+ /**
+ * Enumeration containing properties name values. See CADClient class
+ * description for more information.
+ *
+ * @author Matthew Cechini
+ * @see CADClient
+ */
+ private static enum PROPERTIES {
+ CAD_SIM_HOST("CADSimulatorHost"), CAD_SIM_PORT("CADSimulatorSocketPort"), CAD_RMI_PORT(
+ "CADRmiPort"), CLIENT_CAD_POS("CADPosition"), CLIENT_USER_ID(
+ "CADUserID"), KEYBOARD_TYPE("KeyboardType"), DISPLAY_TYPE(
+ "DisplayType");
+
+ public String name;
+
+ private PROPERTIES(String n) {
+ name = n;
+ }
+ }
+
+ /**
+ * CADClientSocket Object to handle socket communication between the Client
+ * and CAD Simulator.
+ */
+ private CADClientSocket theClientSocket;
+
+ /** Instance of the CADClientModel. */
+ private CADClientModel theClientScreenModel;
+
+ /** Instance of the CADClientView. */
+ private CADClientView theClientScreenView;
+
+ /**
+ * Instance of the CADCLientGUI Replaces CADClientView
+ */
+ private CADClientGUI theClientGUI;
+
+ /** Properties object for the CADClient class. */
+ private Properties cadClientProp;
+
+ /** RMI interface for communication with the remote Coordinator. */
+ private static CoordinatorInterface theCoorInt;
+
+ /** reference to itself to be used for disconnecting from CADSimulator */
+ private CADClientInterface client = this;
+
+ /**
+ * Constructor. Initialize data from parsed properties file. Create a socket
+ * connection to the CADSimulator. The ClientScreenModel is initialized with
+ * the input and output I/O streams for socket communication. The
+ * ClientScreenModel registers with the CAD Simulator, using CAD position
+ * and userID read in from the properties file. The ClientScreenView is then
+ * created and initialized and set as an observer of the model.
+ *
+ * A thread is created with the runnable ClientScreenModel and is started.
+ * When this thread is no longer alive, or the ClientScrenView and
+ * CADClientSocket are closed. The program then exits.
+ *
+ * @param propertiesFile
+ * File path (absolute or relative) to the properties file
+ * containing configuration data.
+ */
+ public CADClient(String propertiesFile) throws SimulationException,
+ RemoteException {
+ if (!verifyProperties(propertiesFile))
+ System.exit(0);
+
+ connect(cadClientProp.getProperty(PROPERTIES.CAD_SIM_HOST.name).trim(),
+ cadClientProp.getProperty(PROPERTIES.CAD_RMI_PORT.name).trim());
+
+ // Instantiate the Socket and Model Objects.
+ theClientSocket = new CADClientSocket(cadClientProp.getProperty(
+ PROPERTIES.CAD_SIM_HOST.name).trim(),
+ Integer.parseInt(cadClientProp.getProperty(
+ PROPERTIES.CAD_SIM_PORT.name).trim()));
+ theClientScreenModel = new CADClientModel();
+ theClientScreenModel.initializeScreen(theClientSocket.getInputStream(),
+ theClientSocket.getOutputStream());
+
+ // Register this CAD Client with the Simulation Manager
+ theClientScreenModel.register(Integer.parseInt(cadClientProp
+ .getProperty(PROPERTIES.CLIENT_CAD_POS.name)), cadClientProp
+ .getProperty(PROPERTIES.CLIENT_USER_ID.name));
+
+ // Instantiate the CADScreenView and set up the model-view observer
+ // relationship.
+ theClientScreenView = new CADClientView(theClientScreenModel);
+ theClientScreenView.setVisible(false);
+
+ // TODO: set up model-view relationship similar to ClientView and
+ // ScreenView
+ // Can repurpose the old model, but may be better to copy over and
+ // modify in parallel
+ // This is required to perform powerline commands on the data
+ theClientGUI = new CADClientGUI();
+
+ // Each screen of the UI should have a reference to either it's parent
+ // object or the main client
+ // This ensures they all have access to each other and the data model
+ theClientGUI.screen = new ScreenManager(theCoorInt);
+ theClientGUI.login = new Login();
+ theClientGUI.client = this;
+
+ // setup keyboard settings for CAD Client
+ if (cadClientProp.getProperty(PROPERTIES.KEYBOARD_TYPE.name).trim()
+ .equals("CAD")) {
+ CADEnums.CAD_KEYS.setupCADKeyboard();
+ }
+ // STD
+ else {
+ CADEnums.CAD_KEYS.setupStandardKeyboard();
+ }
+
+ theClientScreenModel.addObserver(theClientScreenView);
+
+ // Initialize the display
+ if (cadClientProp.getProperty(PROPERTIES.DISPLAY_TYPE.name).equals(
+ "FULL_SCREEN")) {
+
+ theClientScreenView.addWindowListener(new WindowListener() {
+ public void windowClosed(WindowEvent e) {
+ }
+
+ public void windowOpened(WindowEvent e) {
+ }
+
+ public void windowIconified(WindowEvent e) {
+ }
+
+ public void windowDeiconified(WindowEvent e) {
+ }
+
+ public void windowActivated(WindowEvent e) {
+ }
+
+ public void windowDeactivated(WindowEvent e) {
+ }
+
+ public void windowClosing(WindowEvent e) {
+
+ try {
+ theClientSocket.closeSocket();
+ } catch (SimulationException se) {
+ }
+
+ System.exit(0);
+ }
+ });
+
+ theClientScreenView.initWindow();
+ theClientScreenView.setVisible(false);
+ } else {
+ JFrame cadFrame = new JFrame("CAD Client");
+ cadFrame.add(theClientScreenView.initBox());
+ cadFrame.setSize(800, 600);
+
+ cadFrame.addWindowListener(new WindowListener() {
+ public void windowClosed(WindowEvent e) {
+ }
+
+ public void windowOpened(WindowEvent e) {
+ }
+
+ public void windowIconified(WindowEvent e) {
+ }
+
+ public void windowDeiconified(WindowEvent e) {
+ }
+
+ public void windowActivated(WindowEvent e) {
+ }
+
+ public void windowDeactivated(WindowEvent e) {
+ }
+
+ public void windowClosing(WindowEvent e) {
+
+ try {
+ theClientSocket.closeSocket();
+ } catch (SimulationException se) {
+ }
+
+ System.exit(0);
+ }
+ });
+
+ cadFrame.setVisible(true);
+ }
+
+ // Create the CAD Client thread to run the CADClientModel Object.
+ Thread clientThread = new Thread(theClientScreenModel);
+ clientThread.start();
+
+ ensureProperShutdown();
+ }
+
+ /**
+ * Connect to the Coordinator's RMI object, and register this object for
+ * callback with the Coordinator.
+ *
+ * @param hostname
+ * Host name of the CAD Simulator.
+ * @param portNumber
+ * Port number of the CAD Simulator RMI communication.
+ * @throws SimulationException
+ * if there is an error creating the RMI connection.
+ */
+ protected void connect(String hostname, String portNumber)
+ throws SimulationException {
+
+ String coorIntURL = "";
+
+ try {
+ coorIntURL = "rmi://" + hostname + ":" + portNumber
+ + "/coordinator";
+ theCoorInt = (CoordinatorInterface) Naming.lookup(coorIntURL);
+ theCoorInt.registerForCallback(this);
+ } catch (Exception e) {
+ throw new SimulationException(SimulationException.CAD_SIM_CONNECT,
+ e);
+ }
+ }
+
+ /**
+ * This method verifies that the CAD Simulator Host and Port values are not
+ * null. Also, if a CAD Position or User ID do not exist in the properties
+ * file, the user is prompted to enter values. These values are written to
+ * the properties file. If the user cancels the process of entering these
+ * values, the verification fails.
+ *
+ * @param propertiesFile
+ * File path (absolute or relative) to the properties file
+ * containing configuration data.
+ * @return True if the properties file is valid, false if not.
+ * @throws SimulationException
+ * if there is an exception in verifying the properties file, or
+ * if the user cancels input.
+ */
+ private boolean verifyProperties(String propertiesFile)
+ throws SimulationException {
+
+ // Load the properties file.
+ try {
+ cadClientProp = new Properties();
+ cadClientProp.load(new FileInputStream(propertiesFile));
+ } catch (Exception e) {
+ cadClientLogger.logp(Level.SEVERE, "SimulationManager",
+ "Constructor", "Exception in reading properties file.", e);
+
+ throw new SimulationException(SimulationException.INITIALIZE_ERROR,
+ e);
+ }
+
+ // Ensure that the properties file does not have null values for the
+ // CAD Simulator's connection information.
+ if (cadClientProp.getProperty(PROPERTIES.CAD_SIM_HOST.name) == null
+ || cadClientProp.getProperty(PROPERTIES.CAD_SIM_PORT.name) == null) {
+ cadClientLogger.logp(Level.SEVERE, "SimulationManager",
+ "Constructor", "Null value in properties file.");
+ throw new SimulationException(SimulationException.INITIALIZE_ERROR);
+ }
+
+ try {
+ // If the properties file does not specify a CAD position, prompt
+ // the
+ // user to select one. If the user selects a position, write the
+ // new properties values to the file. If the user cancels, else
+ // throw an exception.
+ if (cadClientProp.getProperty(PROPERTIES.CLIENT_CAD_POS.name) == null) {
+ if (getCADPosition())
+ cadClientProp.store(new FileOutputStream(propertiesFile),
+ "");
+ else
+ throw new SimulationException(
+ SimulationException.INITIALIZE_ERROR);
+ }
+
+ // If the properties file does not specifiy a CAD User ID, prompt
+ // the
+ // user to enter a value. If the user enters a valid ID, write the
+ // new properties values to the file. If the user cancels, else
+ // throw an exception.
+ if (cadClientProp.getProperty(PROPERTIES.CLIENT_USER_ID.name) == null) {
+ if (getUserID())
+ cadClientProp.store(new FileOutputStream(propertiesFile),
+ "");
+ else
+ throw new SimulationException(
+ SimulationException.INITIALIZE_ERROR);
+ }
+ } catch (IOException ioe) {
+ cadClientLogger.logp(Level.SEVERE, "SimulationManager",
+ "Constructor",
+ "Exception in writing to the properties file.");
+ throw new SimulationException(SimulationException.INITIALIZE_ERROR);
+ }
+
+ // Ensure that the properties file has a valid display type
+ if (cadClientProp.getProperty(PROPERTIES.DISPLAY_TYPE.name) == null
+ || (!cadClientProp.getProperty(PROPERTIES.DISPLAY_TYPE.name)
+ .equals("FULL_SCREEN") && !cadClientProp.getProperty(
+ PROPERTIES.DISPLAY_TYPE.name).equals("FRAME"))) {
+ cadClientLogger.logp(Level.SEVERE, "SimulationManager",
+ "Constructor", "Invalid display type.");
+ throw new SimulationException(SimulationException.INITIALIZE_ERROR);
+ }
+
+ return true;
+ }
+
+ /**
+ * This method prompts the user to select a value for the CAD position. If
+ * the user cancels the method returns false, else the Properties object is
+ * updated and true is returned.
+ *
+ * @return True if the user successfully selected a CAD position, false if
+ * not.
+ */
+ private boolean getCADPosition() {
+
+ Vector| CAD Protocol Command |
+ * Action Taken |
+ *
|---|---|
| UPDATE_SCREEN |
+ * A completely new window has been received. Parse the received
+ * data into an XML Document. The root node is used to determine
+ * which type of CAD Screen is being shown. Construct the new
+ * CADScreenModel for that CAD Screem amd notify the view observer with the new
+ * screen type and model. |
+ *
| UPDATE_STATUS | + *Notify the view observer with the new screen update status value. |
+ *
| UPDATE_TIME | + *Notify the view observer with the new CAD Time value. |
+ *
| UPDATE_MSG_COUNT | + *Notify the view observer with the new queued message count value. |
+ *
| UPDATE_MSG_UNREAD | + *Notify the view observer with the new boolean unread messages value. |
+ *
| CAD_INFO | + *Notify the view observer with the received informational message value. |
+ *
| Direction |
+ * Action Taken |
+ *
|---|---|
| LEFT |
+ * If command line position is not at the beginning of the command + * line, decrement the position and move the Caret back one space. | + *
| UP |
+ * If the command line position is at the end of a full(160 character) + * command, move back 81 characters to the end of the previous line. + * If the command line is not full, but the position is on the second + * line, move back 80 characters. Move the Caret back the same + * number of spaces. (The descrepancy in moving 81 or + * 80 charactes has to do with the value of the position counter + * when it is at the end of a full command line) | + *
| RIGHT | + *If command line position is not at the end of the command line, + * increment the position and move the Caret foward one space. | + *
| DOWN | + *If the command line position is on the first line of the command + * line, and is directly above or to the left of the last character + * on the second line, move forward 80 characters. Else if the + * position is on the first line and there is a second line, move the + * position to the end of the command line. Move the Caret forward + * the same number of spaces. | + *
| CAD Protocol Command |
+ * Action Taken |
+ *
|---|---|
| SHIFT_KEY |
+ * Set shiftKeyPressed flag to true. |
+ *
| COMMAND_LINE_CLEAR |
+ * If the shift key is pressed, clear the current CAD Screen's command line. |
+ *
| SCREEN_CLEAR |
+ * If the shift key is pressed, transmit the SCREEN_CLEAR
+ * command as a TERMINAL_FUNCTION to the CAD Simulator |
+ *
| CAD Protocol Command |
+ * Action Taken |
+ *
|---|---|
| SHIFT_KEY |
+ * Set the shiftKeyPressed flag to false. |
+ *
| CYCLE |
+ * Preserve the current page number to return the screen to the same location after
+ * the cycle. Transmit the current command line to the CAD Simulator with a
+ * SAVE_COMMAND_LINE message type. Transmit the CYCLE command as a
+ * TERMINAL_FUNCTION to the CAD Simulator. |
+ *
| REFRESH |
+ * Preserve the current page number to return the screen to the same location after
+ * the refresh. Transmit the current command line to the CAD Simulator with a
+ * SAVE_COMMAND_LINE message type. Transmit the CYCLE command as a
+ * TERMINAL_FUNCTION to the CAD Simulator. |
+ *
| PGDN | + *Notify the main pane object of the received page down command. |
+ *
| PGUP | + *Notify the main pane object of the received page up command. |
+ *
| LEFT_ARROW | + *Notify the command line pane object of the received left arrow. |
+ *
| UP_ARROW | + *Notify the command line pane object of the received up arrow. |
+ *
| RIGHT_ARROW | + *Notify the command line pane object of the received right arrow. |
+ *
| DOWN_ARROW | + *Notify the command line pane object of the received down arrow. |
+ *
| COMMAND_LINE_TX |
+ * Parse the current command line and create an XMLWriter with the
+ * converted XML representation of the command line data.
+ * Transmit the command line as a TERMINAL_CMD_LINE message to
+ * the CAD Simulator. Clear the current CAD screen's command line.
+ * If there is an error in parsing, show the corresponding error
+ * message and clear the command line. |
+ *
| NEXT_QUEUE |
+ * Transmit the NEXT_QUEUE command as a TERMINAL_FUNCTION to the CAD Simulator. |
+ *
| DELETE_QUEUE |
+ * Transmit the DELETE_QUEUE command as a TERMINAL_FUNCTION to the CAD Simulator. |
+ *
| PREV_QUEUE |
+ * Transmit the PREV_QUEUE command as a TERMINAL_FUNCTION to the CAD Simulator. |
+ *
| BACKSPACE |
+ * Notify the command line pane of the received backspace command. |
+ *
| ENTER |
+ * Currently, do nothing |
+ *
| Message Type | + *Message Data | + *Action Taken | + *
|---|---|---|
| INCIDENT_INQUIRY |
+ * IncidentInquiryModel |
+ * Construct a new II_IncidentInquiry view pane from the model data. + * Reset the observer relationship between the footer and main pane. + * Update the page location map and update the views with the model data. + * | + *
| INCIDENT_SUMMARY |
+ * IncidentSummaryModel |
+ * Construct a new SA_IncidentSummary view pane from the model data. + * Reset the observer relationship between the footer and main pane. + * Update the page location map and update the views with the model data. + * | + *
| INCIDENT_BOARD |
+ * IncidentBoardModel |
+ * Construct a new IB_IncidentBoard view pane from the model data. + * Reset the observer relationship between the footer and main pane. + * Update the page location map and update the views with the model data. + * | + *
| ROUTED_MESSAGE |
+ * RoutedMessageModel |
+ * Construct a new TO_RoutedMessage view pane from the model data. + * Reset the observer relationship between the footer and main pane. + * Update the page location map and update the views with the model data. + * | + *
| BLANK_SCREEN |
+ * BlankScreenModel |
+ * Construct a new empty view pane. + * Reset the observer relationship between the footer and main pane. + * Update the page location map and update the views with the model data. + * | + *
| SCREEN_UPDATE |
+ * TreeMap |
+ * Update the footer pane with the new screen updates map. | + *
| TIME_UPDATE |
+ * Time String |
+ * Update the footer pane with the new time. | + *
| ROUTED_MESSAGE_COUNT_UPDATE |
+ * # Routed Messages |
+ * Update the footer pane with the new number of routed messages. | + *
| ROUTED_MESSAGE_UNREAD_UPDATE |
+ * Unread Routed Messages Boolean |
+ * Update the footer pane with the unread messages boolean. | + *
| CAD_INFO_MESSAGE |
+ * Information message |
+ * Update the footer pane with the new info message. | + *
| CAD Command Token | + *CAD Command | + *Additional Information | + *Possible Errors | + *
|---|---|---|---|
| IB | + *Incident Board | + *None | + *None | + *
| II | + *Incident Inquiry | + *Numerical log number | + *Log number contains invalid characters. | + *
| SA | + *Incident Summary By Area | + *None | + *None | + *
| UI | + *Incident Update | + *1) Numerical log number (optional) + * 2) CAD Field Codes with associated data |
+ * Missing Field Codes. | + *
| TO | + *Routed Mssage | + *1) Recipient CAD Position Numbers or Mnemonics + * 2) Message text |
+ * 1) Missing Recipients + * 2) Missing Message Field Code |
+ *
| OF | + *Log Terminal Off | + *None | + *None | + *
+ * -----------------------------------------------------------------------------
+ * Host Name The host name where the CADSimulator is located.
+ * Error File The target file to use for error logging.
+ * -----------------------------------------------------------------------------
+ * Example File:
+ * CADSimulatorHost = localhost
+ * ErrorFile = sim_mgr_error.xml
+ * -----------------------------------------------------------------------------
+ *
+ *
+ * @author Matthew Cechini (mcechini@calpoly.edu)
+ * @version $Date: 2009/04/17 16:27:47 $ $Revision: 1.7
+ */
+public class SimulationManager {
+
+ /** Error logger. */
+ private static Logger simManLogger = Logger.getLogger("tmcsim.simulationmanager");
+
+ /**
+ * Enumeration containing property names.
+ * @author Matthew Cechini
+ */
+ private static enum PROPERTIES {
+ CAD_SIM_HOST ("CADSimulatorHost"),
+ CAD_SIM_PORT ("CADSimulatorRMIPort"),
+ SCRIPT_DIR ("ScriptDir"),
+ FAKE_PARAMICS ("FakeParamicsConnection");
+
+ public String name;
+
+ private PROPERTIES(String n) {
+ name = n;
+ }
+
+ }
+
+ /**
+ * Instance of the SimulationManagerModel which communicates with the
+ * CAD Simulator to display the current simulation information. This
+ * model class contains the data that is displayed by the SimulationManagerView
+ * class. The View purely provides a GUI interface for the data contained within
+ * the model.
+ */
+ private SimulationManagerModel theSimManagerModel;
+
+ /**
+ * Instance of the SimulationManagerView class which provides a GUI for the user
+ * to view the current simulation information and to manage the simulation. The
+ * view communicates to the SimulationManagerModel class to get and set data.
+ */
+ SimulationManagerView theSimManagerView;
+
+ /** The Properties object for the Simulation Manager. */
+ private Properties simManagerProperties;
+
+ /**
+ * Constructor. Set communication data members from properties file. Instantiate
+ * the SimulationManager Model and View objects, and set visibility to true.
+ *
+ * @param propertiesFile Properties file containing info for Simulation Manager.
+ */
+ public SimulationManager(String propertiesFile) throws SimulationException {
+
+ try {
+ simManagerProperties = new Properties();
+ simManagerProperties.load(new FileInputStream(new File(propertiesFile)));
+
+ SimulationManagerView.SCRIPT_DIR =
+ simManagerProperties.getProperty(PROPERTIES.SCRIPT_DIR.name).trim();
+
+ //make sure properties aren't null
+ if(simManagerProperties.getProperty(PROPERTIES.CAD_SIM_HOST.name) == null)
+ throw new Exception("CAD Simulator host property is null.");
+
+ if(simManagerProperties.getProperty(PROPERTIES.CAD_SIM_PORT.name) == null)
+ throw new Exception("CAD Simulator port property is null.");
+
+ }
+ catch (Exception e)
+ {
+ simManLogger.logp(Level.SEVERE, "SimulationManager", "Constructor",
+ "Exception in reading properties file.", e);
+
+ throw new SimulationException(SimulationException.INITIALIZE_ERROR, e);
+ }
+
+ //Construct the SimulationManagerModel
+ try
+ {
+ theSimManagerModel = new SimulationManagerModel(
+ simManagerProperties.getProperty(PROPERTIES.CAD_SIM_HOST.name).trim(),
+ simManagerProperties.getProperty(PROPERTIES.CAD_SIM_PORT.name).trim());
+
+ //Construct the SimulationManagerView and set up the Model-View references.
+ theSimManagerView = new SimulationManagerView(theSimManagerModel);
+ theSimManagerModel.setView(theSimManagerView);
+ }
+ catch (RemoteException re)
+ {
+ simManLogger.logp(Level.SEVERE, "SimulationManager", "Constructor",
+ "Unable to establish RMI ", re);
+
+ throw new SimulationException(SimulationException.CAD_SIM_CONNECT, re);
+ }
+
+ theSimManagerView.addWindowListener(new WindowListener() {
+ public void windowClosed(WindowEvent e) {}
+ public void windowOpened(WindowEvent e) {}
+ public void windowIconified(WindowEvent e) {}
+ public void windowDeiconified(WindowEvent e) {}
+ public void windowActivated(WindowEvent e) {}
+ public void windowDeactivated(WindowEvent e) {}
+ public void windowClosing(WindowEvent e) {
+ theSimManagerModel.disconnect();
+ System.exit(0);
+ }
+ });
+
+ if(Boolean.parseBoolean(simManagerProperties.getProperty(
+ PROPERTIES.FAKE_PARAMICS.name).trim()))
+ {
+ theSimManagerView.setParamicsStatus(PARAMICS_STATUS.CONNECTED);
+ }
+
+ //Show the SimulationManager
+ theSimManagerView.setVisible(true);
+ }
+
+ /**
+ * Main class.
+ *
+ * @param args Command line arguments.
+ */
+ static public void main(String[] args) {
+ System.setProperty("SIM_MGR_PROPERTIES", "config/sim_manager_config.properties");
+
+ try {
+ if(System.getProperty("SIM_MGR_PROPERTIES") != null)
+ {
+ UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
+
+ new SimulationManager(System.getProperty("SIM_MGR_PROPERTIES"));
+ }
+ else
+ {
+ throw new Exception ("SIM_MGR_PROPERTIES system property not defined.");
+ }
+ }
+ catch (Exception e)
+ {
+ simManLogger.logp(Level.SEVERE, "SimulationManager", "Main",
+ "Error occured initializing application", e);
+
+ JOptionPane.showMessageDialog(null, e.getMessage(),
+ "Error - Program Exiting", JOptionPane.ERROR_MESSAGE);
+
+ System.exit(-1);
+ }
+
+ }
+}
+
+
+
+
+
+
+
Index: trunk/src/tmcsim/simulationmanager/SimulationManagerModel.java
===================================================================
--- trunk/src/tmcsim/simulationmanager/SimulationManagerModel.java (revision 2)
+++ trunk/src/tmcsim/simulationmanager/SimulationManagerModel.java (revision 2)
@@ -0,0 +1,633 @@
+package tmcsim.simulationmanager;
+
+import java.io.File;
+import java.rmi.Naming;
+import java.rmi.RemoteException;
+import java.rmi.server.UnicastRemoteObject;
+import java.util.TreeMap;
+import java.util.TreeSet;
+import java.util.Vector;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+import tmcsim.cadmodels.CMSDiversion;
+import tmcsim.cadmodels.CMSInfo;
+import tmcsim.client.cadclientgui.data.Incident;
+import tmcsim.client.cadclientgui.data.IncidentEvent;
+import tmcsim.common.ScriptException;
+import tmcsim.common.SimulationException;
+import tmcsim.common.CADEnums.PARAMICS_STATUS;
+import tmcsim.common.CADEnums.SCRIPT_STATUS;
+import tmcsim.interfaces.CoordinatorInterface;
+import tmcsim.interfaces.SimulationManagerInterface;
+
+
+/**
+ * SimulationManagerModel is the model class for the Simulation Manager. All communication
+ * between the Coordinator and the Simulation Manager passes through this object. The view
+ * passes requests through local methods, and the Coordinator calls remote functions in this
+ * object to update the viewed simulation data.
+ * | Status |
+ * Actions Taken |
+ *
|---|---|
| NO_SCRIPT |
+ * Set the simulation status text to a black "No Script". Then
+ * disable all simulation buttons. Enable the 'Load Script' button. |
+ *
| SCRIPT_STOPPED_NOT_STARTED |
+ * Set the simulation status text to a red "Not Started". Then
+ * enable the 'Start' and 'Reset' buttons, and disable the 'Pause'
+ * button. Enable the 'Load Script' button. |
+ *
| SCRIPT_STOPPED_STARTED |
+ * Set the simulation status text to a red "Paused". Then
+ * enable the 'Start' and 'Reset' buttons, and disable the 'Pause'
+ * button. Enable the 'Load Script' button. Set the simulationStarted
+ * flag to true. |
+ *
| SCRIPT_RUNNING |
+ * Set the simulation status text to a green "Running". Then
+ * disable the 'Start' and 'Reset' buttons, and enable the 'Pause'
+ * button. Disable the 'Load Script' button. Set the simulationStarted
+ * flag to true. |
+ *
| ATMS_SYNCHRONIZATION |
+ * Set the simulation status text to an orange "Synchronizing". Then
+ * disable all simulation buttons and the 'Load Script' button. |
+ *
| Status |
+ * Actions Taken |
+ *
|---|---|
| UNREACHABLE |
+ * Show a message dialog to the user notifying them that a
+ * connection to Paramics could not be made. Reset the
+ * connect button to be labled 'Connect to Paramics' and
+ * set the status text to 'Unreachable'. Enable the connect
+ * button and disable the network load button. Set the connected
+ * to paramics flag to false. |
+ *
| DROPPED |
+ * Show a message dialog to the user notifying them that the
+ * connection to Paramics has been dropped. Reset the
+ * connect button to be labled 'Connect to Paramics' and
+ * set the status text to 'Dropped'. |
+ *
| CONNECTING |
+ * Set the status text to 'Connecting'. Disable the connect
+ * button and network load button. |
+ *
| CONNECTED |
+ * Set the connect button to be labled 'Disconnect from Paramics'
+ * and set the status text to 'Connected'. Enable the disconnect
+ * button and network load button. Set the connected to paramics flag
+ * to true. |
+ *
| DISCONNECTED |
+ * Set the connect button to be labled 'Connect to Paramics'
+ * and set the status text to 'Disconnected'. Enable the connect
+ * button and disable the network load button. Set the connected
+ * to paramics flag to false. |
+ *
| SENDING_NETWORK_ID |
+ * Set the status text to 'Sending Network ID'. Disable the
+ * network load button. |
+ *
| WARMING |
+ * Set the status text to 'Warming'. |
+ *
| LOADING |
+ * Set the status text to 'Loading'. |
+ *
| LOADED |
+ * Get the paramics network that has been been loaded from
+ * the model. Set the status text to 'Network # Loaded'.
+ * Enable the connect button and disable the network
+ * load button |
+ *
+ * -----------------------------------------------------------------------------
+ * Socket Port The port number to use for socket communication.
+ * Working Directory The working directory use for Paramics file communication.
+ * Error File The target file to use for error logging.
+ * -----------------------------------------------------------------------------
+ * Example File:
+ * SocketPort = 4450
+ * WorkingDirectory = c:\\tmc_simulator\\
+ * ErrorFile = sim_mgr_error.xml
+ * -----------------------------------------------------------------------------
+ *
+ *
+ * @author Matthew Cechini (mcechini@calpoly.edu)
+ * @version $Date: 2009/04/17 16:27:46 $ $Revision: 1.7
+ */
+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");
+
+ public String name;
+
+ private PROPERTIES(String n) {
+ name = n;
+ }
+ }
+
+
+ /** 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. */
+ private ServerSocket serverSocket = null;
+
+ /** 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. */
+ private ObjectOutputStream out = null;
+
+ /** Map of all current ParamicsFileWriters referenced by I/O ID. */
+ private TreeMap