From 7969ac0fc33f41cf4c47d59b76232eeea8c934b7 Mon Sep 17 00:00:00 2001
From: schle <schle@MSI>
Date: Wed, 15 Sep 2021 12:53:05 -0700
Subject: [PATCH] schlessel homework2
---
.../Schlessel/ExampleSimulationProgram.java | 396 ++++++++++++++++++
1 file changed, 396 insertions(+)
create mode 100644 assignments/src/MV3500Cohort2021JulySeptember/homework3/Schlessel/ExampleSimulationProgram.java
diff --git a/assignments/src/MV3500Cohort2021JulySeptember/homework3/Schlessel/ExampleSimulationProgram.java b/assignments/src/MV3500Cohort2021JulySeptember/homework3/Schlessel/ExampleSimulationProgram.java
new file mode 100644
index 0000000000..befe836808
--- /dev/null
+++ b/assignments/src/MV3500Cohort2021JulySeptember/homework3/Schlessel/ExampleSimulationProgram.java
@@ -0,0 +1,396 @@
+/**
+ * Copyright (c) 2008-2021, MOVES Institute, Naval Postgraduate School (NPS). All rights reserved.
+ * This work is provided under a BSD open-source license, see project license.html and license.txt
+ * @author brutzman@nps.edu
+ */
+package MV3500Cohort2021JulySeptember.homework3.Schlessel;
+
+import edu.nps.moves.dis7.entities.swe.platform.surface._001Poseidon;
+import edu.nps.moves.dis7.entities.swe.platform.surface._002Triton;
+import edu.nps.moves.dis7.enumerations.*; // match any
+import edu.nps.moves.dis7.pdus.*; // match any of the PDU classes, easier than listing individually
+import edu.nps.moves.dis7.utilities.DisThreadedNetworkInterface;
+import edu.nps.moves.dis7.utilities.PduFactory;
+import edu.nps.moves.dis7.utilities.stream.PduRecorder;
+import java.util.ArrayList;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+/** The purpose of this program is to provide an easily modifiable example simulation program
+ * that includes DIS-capable entities doing tasks and reporting them to the network.
+ * Default settings include PDU recording turned on by default.
+ */
+public class ExampleSimulationProgram
+{
+ private boolean verboseComments = true;
+ static final String NETWORK_ADDRESS_DEFAULT = "239.1.2.3";
+ static final int NETWORK_PORT_DEFAULT = 3000;
+ static String networkAddress = NETWORK_ADDRESS_DEFAULT;
+ static int networkPort = NETWORK_PORT_DEFAULT;
+ String DEFAULT_OUTPUT_DIRECTORY = "./pduLog";
+
+ /**
+ * This runSimulationLoops() method is for you, a
+ * programmer-modifiable method for defining and running a new simulation of interest.
+ * Welcome! Other parts of this program handle bookkeeping and plumbing tasks so that
+ * you can focus on your model entities and activities.
+ * Expandable support includes DIS EntityStatePdu, FirePdu and CommentPdu all available for
+ * modification and sending in a simulation loop.
+ * Continuous improvement efforts seek to make this program as easy and straightforward
+ * as possible for DIS simulationists to use and adapt.
+ * All of the other methods are setup, teardown and configuration that you may find
+ * interesting, even helpful, but don't really have to worry about.
+ */
+ @SuppressWarnings("SleepWhileInLoop") // yes we do that
+ public void runSimulationLoops ()
+ {
+ try
+ {
+ /** seconds for real-time execution (not simulation time, which may or may not be the same) */
+ final double SIMULATION_LOOP_DURATION_SECONDS = 1.0;
+ final int SIMULATION_MAX_LOOP_COUNT = 10; // be deliberate out out there! also avoid infinite loops.
+ int simulationLoopCount = 0; // variable, initialized at 0
+ boolean simulationComplete = false; // sentinel variable as termination condition,, are we done yet?
+
+ // TODO reset clock to zero each time for consistent outputs
+
+ // Your model setup: define participants. who's who in this zoo?
+ // Assuming you keep track of entity objects... here is some support for for Entity 1.
+
+ // create PDU objects and set their values.
+ EntityID entityID_1 = new EntityID();
+ entityID_1.setSiteID(1).setApplicationID(2).setEntityID(3); // made-up example ID;
+ // create PDU objects and set their values.
+ EntityID entityID_2 = new EntityID();
+ entityID_1.setSiteID(1).setApplicationID(2).setEntityID(4); // made-up example ID;
+ // TODO someday, use enumerations; is there a unique site triplet for MOVES Institute?
+
+ EntityStatePdu entityStatePdu_1 = pduFactory.makeEntityStatePdu();
+ entityStatePdu_1.setEntityID(entityID_1);
+ entityStatePdu_1.setForceId(ForceID.FRIENDLY);
+ entityStatePdu_1.setEntityType(new _001Poseidon()); // note import statement above
+
+ EntityStatePdu entityStatePdu_2 = pduFactory.makeEntityStatePdu();
+ entityStatePdu_2.setEntityID(entityID_2);
+ entityStatePdu_2.setForceId(ForceID.OPPOSING);
+ entityStatePdu_2.setEntityType(new _002Triton()); // note import statement above
+
+ FirePdu firePdu_1a = pduFactory.makeFirePdu(); // for entity 1 first weapon (if any)
+// FirePdu firePdu_1b = pduFactory.makeFirePdu(); // for entity 1 second weapon (if any)
+ // should we customize this munition? what is it for your simulation?
+
+ // TODO simulation management PDUs for startup, planning to design special class support
+
+ // loop the simulation while allowed, programmer can set additional conditions to break out and finish
+ while (simulationLoopCount < SIMULATION_MAX_LOOP_COUNT) // are we done yet?
+ {
+ simulationLoopCount++; // good practice: increment loop counter as first action in that loop
+
+ // =============================================================================================
+ // * your own simulation code starts here! *
+ // =============================================================================================
+
+ // are there any other variables to modify at the beginning of your loop?
+
+ // compute a track, update an ESPDU, whatever it is that your model is doing...
+
+ // Where is my entity? Insert changes in position; this sample only changes X position.
+ entityStatePdu_1.getEntityLocation().setX(entityStatePdu_1.getEntityLocation().getX() + 1.0); // 1m per timestep
+
+ // decide whether to fire, and then update the firePdu. Hmmm, you might want a target to shoort at!
+
+ // etc. etc. your code goes here for your simulation of interest
+
+ // something happens between my simulation entities, la de da de da...
+ System.out.println ("... My simulation just did something, no really...");
+
+
+ // make your reports: narrative code for CommentPdu here (set all to empty strings to avoid sending)
+ narrativeMessage1 = "MV3500 ExampleSimulationProgram";
+ narrativeMessage2 = "runSimulation() loop " + simulationLoopCount;
+ narrativeMessage3 = ""; // intentionally blank for testing
+
+ // your loop termination condition goes here
+ if (simulationLoopCount > 4) // for example
+ {
+ simulationComplete = true;
+ }
+ // =============================================================================================
+ // * your own simulation code is finished here! *
+ // =============================================================================================
+
+ // staying synchronized with timestep: wait duration for elapsed time in this loop
+ // Thread.sleep needs a (long) parameter for milliseconds, which are clumsy to use sometimes
+ Thread.sleep((long)(SIMULATION_LOOP_DURATION_SECONDS * 1000)); // seconds * (1000 msec/sec) = milliseconds
+ System.out.println ("... [Pausing for " + SIMULATION_LOOP_DURATION_SECONDS + " seconds]");
+
+ // OK now send the status PDUs for this loop, and then continue
+ System.out.println ("sending PDUs for simulation step " + simulationLoopCount + ", monitor loopback to confirm sent");
+ sendAllPdusForLoopTimestep(entityStatePdu_1, firePdu_1a, timeStepComment, narrativeMessage1, narrativeMessage2, narrativeMessage3);
+ sendSinglePdu(entityStatePdu_2); // me too i.e. 2!
+ System.out.println ("... [PDUs successfully sent for this loop]");
+
+ // ===============================
+ // loop now finished, check whether to terminate if simulation complete, otherwise continue
+ if (simulationComplete || (simulationLoopCount > 10000)) // for example; including fail-safe condition is good
+ {
+ System.out.println ("... [Termination condition met, simulationComplete=" + simulationComplete + "]"); // ", final loopCount=" + loopCount +
+ break;
+ }
+ } // end of simulation loop
+
+ narrativeMessage2 = "runSimulation() completed successfully"; // all done
+ sendCommentPdu(narrativeComment, narrativeMessage1, narrativeMessage2, narrativeMessage3);
+ System.out.println ("... [final CommentPdu successfully sent for simulation]");
+ // TODO simulation management PDUs
+ }
+ catch (InterruptedException iex) // handle any exception that your code might choose to provoke!
+ {
+ Logger.getLogger(ExampleSimulationProgram.class.getName()).log(Level.SEVERE, null, iex);
+ }
+ }
+ /* **************************** infrastructure code, modification is seldom needed ************************* */
+
+ String narrativeMessage1 = new String();
+ String narrativeMessage2 = new String();
+ String narrativeMessage3 = new String();
+
+ /* VariableRecordType enumerations have potential use with CommentPdu logs */
+ /* TODO contrast to EntityType */
+ VariableRecordType descriptionComment = VariableRecordType.DESCRIPTION;
+ VariableRecordType narrativeComment = VariableRecordType.COMPLETE_EVENT_REPORT;
+ VariableRecordType statusComment = VariableRecordType.APPLICATION_STATUS;
+ VariableRecordType timeStepComment = VariableRecordType.APPLICATION_TIMESTEP;
+ VariableRecordType otherComment = VariableRecordType.OTHER;
+
+ /**
+ * Output prefix to identify this class, helps with logging
+ */
+ private final static String TRACE_PREFIX = "[" + ExampleSimulationProgram.class.getName() + "] ";
+
+ // class variables
+ PduFactory pduFactory = new PduFactory();
+ DisThreadedNetworkInterface disNetworkInterface;
+ DisThreadedNetworkInterface.PduListener pduListener;
+ Pdu receivedPdu;
+ PduRecorder pduRecorder;
+
+ /**
+ * Constructor design goal: additional built-in initialization conveniences can go here
+ * to keep student efforts focused on the runSimulation() method.
+ */
+ public ExampleSimulationProgram()
+ {
+ // Constructor is under consideration. Constructor is not currently needed.
+ }
+
+ /**
+ * Utility Constructor that allows your example simulation program to override default network address and port
+ * @param address network address to use
+ * @param port corresponding network port to use
+ */
+ public ExampleSimulationProgram(String address, int port)
+ {
+ setNetworkAddress(address);
+
+ setNetworkPort(port);
+ }
+
+ /**
+ * @return the networkAddress
+ */
+ public String getNetworkAddress()
+ {
+ return networkAddress;
+ }
+
+ /**
+ * @param newNetworkAddress the networkAddress to set
+ */
+ public final void setNetworkAddress(String newNetworkAddress)
+ {
+ ExampleSimulationProgram.networkAddress = newNetworkAddress;
+ }
+
+ /**
+ * @return the networkPort
+ */
+ public int getNetworkPort()
+ {
+ return networkPort;
+ }
+
+ /**
+ * @param newNetworkPort the networkPort to set
+ */
+ public final void setNetworkPort(int newNetworkPort)
+ {
+ ExampleSimulationProgram.networkPort = newNetworkPort;
+ }
+
+ /**
+ * Initialize network interface, choosing best available network interface
+ */
+ public void setUpNetworkInterface()
+ {
+ disNetworkInterface = new DisThreadedNetworkInterface(getNetworkAddress(), getNetworkPort());
+ disNetworkInterface.setDescriptor ("ExampleSimulationProgram pdu looping");
+
+ System.out.println("Network confirmation:" +
+ " address=" + disNetworkInterface.getAddress()+ // disNetworkInterface.getMulticastGroup() +
+ " port=" + disNetworkInterface.getPort()); // + disNetworkInterface.getDisPort());
+ pduListener = new DisThreadedNetworkInterface.PduListener()
+ {
+ /** Callback handler for listener */
+ @Override
+ public void incomingPdu(Pdu newPdu)
+ {
+ receivedPdu = newPdu;
+ }
+ };
+ disNetworkInterface.addListener(pduListener);
+
+ String outputDirectory = DEFAULT_OUTPUT_DIRECTORY;
+ System.out.println("Beginning pdu save to directory " + outputDirectory);
+ pduRecorder = new PduRecorder(outputDirectory, getNetworkAddress(), getNetworkPort()); // assumes save
+ pduRecorder.setDescriptor ("ExampleSimulationProgram pduRecorder");
+ pduRecorder.setVerbose(true);
+ pduRecorder.start(); // begin running
+ }
+
+ /** All done, release network resources */
+ public void tearDownNetworkInterface()
+ {
+ pduRecorder.stop();
+
+ disNetworkInterface.removeListener(pduListener);
+
+ disNetworkInterface.close();
+// disNetworkInterface.kill(); // renamed as close(), deprecated
+// disNetworkInterface = null; // making sure no possibility of zombie process remaining...
+ }
+
+ /**
+ * Send a single Protocol Data Unit (PDU) of any type
+ * @param pdu the pdu to send
+ */
+ private void sendSinglePdu(Pdu pdu)
+ {
+ try
+ {
+ disNetworkInterface.send(pdu);
+ Thread.sleep(100); // TODO consider refactoring the wait logic and moving externally
+ }
+ catch (InterruptedException ex)
+ {
+ System.err.println(this.getClass().getName() + " Error sending PDU: " + ex.getLocalizedMessage());
+ System.exit(1);
+ }
+ }
+
+ /**
+ * Send Comment PDU
+ * @see <a href="https://docs.oracle.com/javase/tutorial/java/javaOO/arguments.html">Passing Information to a Method or a Constructor</a> Arbitrary Number of Arguments
+ * @param commentType enumeration value describing purpose of the narrative comment
+ * @param comments String array of narrative comments
+ */
+ public void sendCommentPdu(VariableRecordType commentType,
+ // vararg... variable-length set of String comments can optionally follow
+ String... comments)
+ {
+ sendAllPdusForLoopTimestep (null, null, commentType, comments);
+ }
+
+ /**
+ * Send EntityState, Fire, Comment PDUs that got updated for this loop, reflecting state of current simulation timestep.
+ * @see <a href="https://docs.oracle.com/javase/tutorial/java/javaOO/arguments.html">Passing Information to a Method or a Constructor</a> Arbitrary Number of Arguments
+ * @param entityStatePdu the ESPDU to send, if any
+ * @param firePdu the FirePDU to send, if any
+ * @param commentType enumeration value describing purpose of the narrative comment
+ * @param comments String array of narrative comments
+ */
+ public void sendAllPdusForLoopTimestep(EntityStatePdu entityStatePdu,
+ FirePdu firePdu,
+ VariableRecordType commentType,
+ // vararg... variable-length set of String comments can optionally follow
+ String... comments)
+ {
+ if (entityStatePdu != null)
+ sendSinglePdu(entityStatePdu);
+
+ if (firePdu != null)
+ sendSinglePdu(firePdu); // bang
+
+ if ((comments != null) && (comments.length > 0))
+ {
+ ArrayList<String> newCommentsList = new ArrayList<>();
+ for (String comment : comments)
+ {
+ if (!comment.isEmpty())
+ {
+ newCommentsList.add(comment); // OK found something to send
+ }
+ }
+ if (!newCommentsList.isEmpty())
+ {
+ if (commentType == null)
+ commentType = otherComment; // fallback value otherComment
+ // now build the commentPdu from these string inputs, thus constructing a narrative entry
+ CommentPdu commentPdu = pduFactory.makeCommentPdu(commentType, newCommentsList.toArray(new String[0])); // comments);
+ sendSinglePdu(commentPdu);
+ if (isVerboseComments())
+ System.out.println("*** [Narrative comment sent: " + commentType.name() + "] " + newCommentsList.toString());
+ }
+ }
+ }
+
+ /**
+ * Main method is first executed when a program instance is loaded.
+ * @see <a href="https://docs.oracle.com/javase/tutorial/getStarted/application/index.html">Java Tutorials: A Closer Look at the "Hello World!" Application</a>
+ * @param args command-line arguments are an array of optional String parameters that are passed from execution environment during invocation
+ */
+ public static void main(String[] args)
+ {
+ System.out.println(TRACE_PREFIX + "started...");
+
+ ExampleSimulationProgram thisProgram = new ExampleSimulationProgram(); // creates instance
+
+ // initial execution: can handle args array of initialization arguments here
+ if (args.length == 2)
+ {
+ if ((args[0] != null) && !args[0].isEmpty())
+ thisProgram.setNetworkAddress(args[0]);
+
+ if ((args[1] != null) && !args[1].isEmpty())
+ thisProgram.setNetworkPort(Integer.parseInt(args[1]));
+ }
+ else if (args.length != 0)
+ {
+ System.err.println("Usage: " + thisProgram.getClass().getName() + " [address port]");
+ System.exit(-1);
+ }
+ // OK here we go...
+
+ thisProgram.setUpNetworkInterface();
+
+ thisProgram.runSimulationLoops (); // ... your simulation execution code goes in there ...
+
+ thisProgram.tearDownNetworkInterface(); // make sure no processes are left lingering
+
+ System.out.println(TRACE_PREFIX + "complete."); // report successful completion
+ }
+
+ /**
+ * @return whether verboseComments mode is enabled
+ */
+ public boolean isVerboseComments() {
+ return verboseComments;
+ }
+
+ /**
+ * @param newVerboseComments whether verboseComments mode is enabled
+ */
+ public void setVerboseComments(boolean newVerboseComments) {
+ this.verboseComments = newVerboseComments;
+ }
+}
--
GitLab