From 1556119e139d6e9a1e21790c1b0a1d4255641a53 Mon Sep 17 00:00:00 2001
From: Don Brutzman <brutzman@nps.edu>
Date: Sun, 27 Jun 2021 19:13:35 -0700
Subject: [PATCH] javadoc
---
...TrialDisMulticastNetworkingDeprecated.java | 43 ++++++++++++++-----
.../dis7/utilities/stream/PduPlayer.java | 11 +++--
.../dis7/utilities/stream/PduRecorder.java | 3 +-
.../stream/X3dCreateInterpolators.java | 4 +-
.../utilities/stream/X3dCreateLineSet.java | 9 ++--
.../stream/X3dSlidingWindowCompression.java | 8 ++++
6 files changed, 58 insertions(+), 20 deletions(-)
diff --git a/src/edu/nps/moves/dis7/utilities/TrialDisMulticastNetworkingDeprecated.java b/src/edu/nps/moves/dis7/utilities/TrialDisMulticastNetworkingDeprecated.java
index dc5fe9842f..44071d0593 100644
--- a/src/edu/nps/moves/dis7/utilities/TrialDisMulticastNetworkingDeprecated.java
+++ b/src/edu/nps/moves/dis7/utilities/TrialDisMulticastNetworkingDeprecated.java
@@ -27,10 +27,14 @@ public class TrialDisMulticastNetworkingDeprecated
/** deprecated */
public class ByteArrayBufferAndLength
{
+ /** deprecated do not use */
public byte[] bufferByteArray;
+ /** deprecated do not use */
public int length;
- /* deprecated do not use */
+ /** deprecated do not use
+ * @param bufferByteArray deprecated do not use
+ * @param length deprecated do not use */
public ByteArrayBufferAndLength(byte[] bufferByteArray, int length)
{
this.bufferByteArray = bufferByteArray;
@@ -48,13 +52,15 @@ public class TrialDisMulticastNetworkingDeprecated
private InetSocketAddress group;
private NetworkInterface ni;
- /* deprecated do not use */
+ /** deprecated do not use */
public TrialDisMulticastNetworkingDeprecated()
{
this(DisThreadedNetworkInterface.DEFAULT_DIS_PORT, DisThreadedNetworkInterface.DEFAULT_MULTICAST_ADDRESS);
}
- /* deprecated do not use */
+ /** deprecated do not use
+ * @param port deprecated do not use
+ * @param mcastgroup deprecated do not use */
public TrialDisMulticastNetworkingDeprecated(int port, String mcastgroup)
{
DIS_PORT = port;
@@ -70,19 +76,21 @@ public class TrialDisMulticastNetworkingDeprecated
dos = new DataOutputStream(baos);
}
- /* deprecated do not use */
+ /** deprecated do not use
+ * @return deprecated do not use */
public int getPort()
{
return DIS_PORT;
}
- /* deprecated do not use */
+ /** deprecated do not use
+ * @return deprecated do not use */
public String getIp()
{
return MCAST_GROUP;
}
- /* deprecated do not use */
+ /** deprecated do not use */
public void stop()
{
if(rsocket != null) {
@@ -96,7 +104,9 @@ public class TrialDisMulticastNetworkingDeprecated
}
}
- /* deprecated do not use */
+ /** deprecated do not use
+ * @return deprecated do not use
+ * @throws java.io.IOException if network-related error occurs */
public Pdu receivePdu() throws IOException
{
PduFactory pduFactory = new PduFactory();
@@ -107,7 +117,9 @@ public class TrialDisMulticastNetworkingDeprecated
private MulticastSocket rsocket;
byte buffer[];
DatagramPacket packet;
- /* deprecated do not use */
+ /** deprecated do not use
+ * @return deprecated do not use
+ * @throws java.io.IOException if network-related error occurs */
public ByteArrayBufferAndLength receiveRawPdu() throws IOException
{
rsocket = new MulticastSocket(DIS_PORT);
@@ -125,7 +137,12 @@ public class TrialDisMulticastNetworkingDeprecated
return new ByteArrayBufferAndLength(packet.getData(), packet.getLength());
}
- public void sendPdu(Pdu pdu) throws Exception
+ /**
+ * deprecated do not use
+ * @param pdu deprecated do not use
+ * @throws Exception if network-related error occurs
+ */
+ public void sendPdu(Pdu pdu) throws Exception
{
// turn object into byte stream
pdu.marshal(dos);
@@ -134,7 +151,13 @@ public class TrialDisMulticastNetworkingDeprecated
}
private MulticastSocket ssocket;
- public void sendRawPdu(byte[] data) throws IOException
+
+ /**
+ * deprecated do not use
+ * @param data deprecated do not use
+ * @throws IOException if network-related error occurs
+ */
+ public void sendRawPdu(byte[] data) throws IOException
{
ssocket = new MulticastSocket();
ssocket.joinGroup(group, ni);
diff --git a/src/edu/nps/moves/dis7/utilities/stream/PduPlayer.java b/src/edu/nps/moves/dis7/utilities/stream/PduPlayer.java
index e83fd6949c..01fbe9f0f8 100644
--- a/src/edu/nps/moves/dis7/utilities/stream/PduPlayer.java
+++ b/src/edu/nps/moves/dis7/utilities/stream/PduPlayer.java
@@ -29,7 +29,8 @@ public class PduPlayer {
/** PDU listener interface */
public interface RawListener {
- /** callback */
+ /** callback
+ * @param ba byte array for receipts */
void receiveBytes(byte[] ba);
}
@@ -87,8 +88,12 @@ public class PduPlayer {
private byte[] globalByteBufferForX3dInterPolators = null;
// -------------------- End Variables for X3D autogenerated code
- public void addRawListener(RawListener lis) {
- rawListener = lis;
+ /**
+ * Method to add listener
+ * @param listener listener of interest
+ */
+ public void addRawListener(RawListener listener) {
+ rawListener = listener;
}
/** Thread process for this class */
diff --git a/src/edu/nps/moves/dis7/utilities/stream/PduRecorder.java b/src/edu/nps/moves/dis7/utilities/stream/PduRecorder.java
index f0ab341b95..a688f0c59e 100644
--- a/src/edu/nps/moves/dis7/utilities/stream/PduRecorder.java
+++ b/src/edu/nps/moves/dis7/utilities/stream/PduRecorder.java
@@ -138,7 +138,8 @@ public class PduRecorder implements PduReceiver
{
running = false;
}
- /** End operation of this instance */
+ /** End operation of this instance
+ * @return recorder logFile */
public File end()
{
running = false;
diff --git a/src/edu/nps/moves/dis7/utilities/stream/X3dCreateInterpolators.java b/src/edu/nps/moves/dis7/utilities/stream/X3dCreateInterpolators.java
index 3079b02e17..b1a3e051d7 100644
--- a/src/edu/nps/moves/dis7/utilities/stream/X3dCreateInterpolators.java
+++ b/src/edu/nps/moves/dis7/utilities/stream/X3dCreateInterpolators.java
@@ -111,8 +111,8 @@ public class X3dCreateInterpolators {
}
}
- public void makeX3dInterpolator() {
-
+ public void makeX3dInterpolator()
+ {
//Compression of the testMap.
//Remove all collinear points.
X3dSlidingWindowCompression slidingWindowCompression = new X3dSlidingWindowCompression(testMap);
diff --git a/src/edu/nps/moves/dis7/utilities/stream/X3dCreateLineSet.java b/src/edu/nps/moves/dis7/utilities/stream/X3dCreateLineSet.java
index 8e68160be2..8176a11429 100644
--- a/src/edu/nps/moves/dis7/utilities/stream/X3dCreateLineSet.java
+++ b/src/edu/nps/moves/dis7/utilities/stream/X3dCreateLineSet.java
@@ -35,15 +35,16 @@ public class X3dCreateLineSet {
private NumberFormat coordinateNumberFormat = NumberFormat.getInstance(new Locale("en", "US"));
// -------------------- End Variables for Position Interpolator
- public X3dCreateLineSet() {
+ /** Constructor */
+ public X3dCreateLineSet()
+ {
//3 significant digits equals milimeter position accuracy and 0.001 radians = 0.0572963266634555‬ degrees
coordinateNumberFormat.setMaximumFractionDigits(3);
-
}
- public void addPointsToMap(byte[] localBufferShort) {
-
+ public void addPointsToMap(byte[] localBufferShort)
+ {
this.bufferShort = localBufferShort.clone();
if (bufferShort[2] == 1) {
diff --git a/src/edu/nps/moves/dis7/utilities/stream/X3dSlidingWindowCompression.java b/src/edu/nps/moves/dis7/utilities/stream/X3dSlidingWindowCompression.java
index 862a0e3654..fb3b9978fa 100644
--- a/src/edu/nps/moves/dis7/utilities/stream/X3dSlidingWindowCompression.java
+++ b/src/edu/nps/moves/dis7/utilities/stream/X3dSlidingWindowCompression.java
@@ -18,6 +18,10 @@ public class X3dSlidingWindowCompression {
private Map<Double, X3dCoordinates> localMap;
+ /**
+ * Constructor
+ * @param localHashMap double map of X3dCoordinates
+ */
public X3dSlidingWindowCompression(Map<Double, X3dCoordinates> localHashMap) {
this.localMap = new LinkedHashMap<>();
@@ -27,6 +31,10 @@ public class X3dSlidingWindowCompression {
}
}
+ /**
+ * Perform sliding window computations
+ * @return double map of X3dCoordinates
+ */
public Map<Double, X3dCoordinates> doSlidingWindow() {
System.out.println("DISTools.Regression.doRegression()");
--
GitLab