From 30e0c2f1bfd08d44e52f3a4baeda201f2b41e83e Mon Sep 17 00:00:00 2001
From: Don Brutzman <brutzman@nps.edu>
Date: Thu, 27 Aug 2020 21:43:41 -0700
Subject: [PATCH] cleanups, javadoc warnings
---
.../dis7/examples/ClassNameComparator.java | 4 +-
.../nps/moves/dis7/examples/EspduSender.java | 2 +-
.../dis7/utilities/DisThreadedNetIF.java | 49 ++++--
.../nps/moves/dis7/utilities/PduFactory.java | 160 +++++++++---------
.../dis7/utilities/stream/X3dCoordinates.java | 12 +-
test/edu/nps/moves/dis7/CommentPdusTest.java | 37 ++--
6 files changed, 144 insertions(+), 120 deletions(-)
diff --git a/src/edu/nps/moves/dis7/examples/ClassNameComparator.java b/src/edu/nps/moves/dis7/examples/ClassNameComparator.java
index f589721e17..187d0b60ab 100644
--- a/src/edu/nps/moves/dis7/examples/ClassNameComparator.java
+++ b/src/edu/nps/moves/dis7/examples/ClassNameComparator.java
@@ -25,8 +25,8 @@ public class ClassNameComparator implements Comparator<Pdu> {
* Returns a number less than, equal to, or greater than zero,
* depending on whether the object is lexically less than, equal to,
* or greater than the other object.
- * @param object1
- * @param object2
+ * @param object1 first object to compare
+ * @param object2 second object to compare
*/
@Override
public int compare(Pdu object1, Pdu object2) {
diff --git a/src/edu/nps/moves/dis7/examples/EspduSender.java b/src/edu/nps/moves/dis7/examples/EspduSender.java
index 0a4033357e..232b938ccb 100644
--- a/src/edu/nps/moves/dis7/examples/EspduSender.java
+++ b/src/edu/nps/moves/dis7/examples/EspduSender.java
@@ -38,7 +38,7 @@ public class EspduSender
* If in multicast mode, a join() will be done on the multicast address.
* port: port used for both source and destination.
*
- * @param args
+ * @param args command-line arguments
*/
public static void main(String args[])
{
diff --git a/src/edu/nps/moves/dis7/utilities/DisThreadedNetIF.java b/src/edu/nps/moves/dis7/utilities/DisThreadedNetIF.java
index 24c9811b48..1c05cfee51 100644
--- a/src/edu/nps/moves/dis7/utilities/DisThreadedNetIF.java
+++ b/src/edu/nps/moves/dis7/utilities/DisThreadedNetIF.java
@@ -25,6 +25,9 @@ import java.util.logging.Logger;
*/
public class DisThreadedNetIF
{
+ private static final String messagePrefix = "[" + DisThreadedNetIF.class.getName() + "] ";
+ private boolean verbose = true;
+
/** Pdu listener interface */
public interface PduListener
{
@@ -111,8 +114,8 @@ public class DisThreadedNetIF
private final LinkedBlockingQueue<Pdu> pdus2send = new LinkedBlockingQueue<>();
/**
- * Add a listener to accept only pdus of a given typ
- * @param lis instance of PduListener
+ * Add a listener to accept only pdus of a given type
+ * @param lis listener instance implementing the RawPduListener interface
* @param typ Pdu type
*/
public void addListener(PduListener lis, DISPDUType typ)
@@ -131,7 +134,7 @@ public class DisThreadedNetIF
/**
* Add a listener to accept all pdu types
- * @param lis instance implementing the PduListener interface
+ * @param lis listener instance implementing the RawPduListener interface
*/
public void addListener(PduListener lis)
{
@@ -140,7 +143,7 @@ public class DisThreadedNetIF
/**
* Remove previously added listener
- * @param lis instance implementing the PduListener interface
+ * @param lis listener instance implementing the RawPduListener interface
*/
public void removeListener(PduListener lis)
{
@@ -155,7 +158,7 @@ public class DisThreadedNetIF
/**
* Add a listener to accept pdus of all types in the form of a byte array
- * @param lis instance implementing the RawPduListener interface
+ * @param lis listener instance implementing the RawPduListener interface
*/
public void addRawListener(RawPduListener lis)
{
@@ -164,7 +167,7 @@ public class DisThreadedNetIF
/**
* Remove previously added raw listener
- * @param lis
+ * @param lis listener instance implementing the RawPduListener interface
*/
public void removeRawListener(RawPduListener lis)
{
@@ -240,15 +243,16 @@ public class DisThreadedNetIF
if (pdu != null)
{
counter++; // TODO experimental, add to generator as a commented-out diagnostic; consider adding diagnostic mode
- System.err.println(counter + ". received " + pdu.getPduType().name());
+ if (verbose)
+ System.err.println(messagePrefix + counter + ". received " + pdu.getPduType().toString());
toListeners(pdu);
}
buffer.clear();
}
}
catch (IOException ex) {
- System.err.println("Exception in DisThreadedNetIF receive thread: " + ex.getLocalizedMessage());
- System.err.println("Retrying new socket in 1 second");
+ System.err.println(messagePrefix + "Exception in DisThreadedNetIF receive thread: " + ex.getLocalizedMessage());
+ System.err.println(messagePrefix + "Retrying new socket in 1 second");
}
finally {
if (socket != null && !socket.isClosed()) {
@@ -286,8 +290,10 @@ public class DisThreadedNetIF
baos.reset();
}
- } catch (Exception ex) {
- System.err.println("Exception in DisThreadedNetIF send thread: " + ex.getLocalizedMessage());
+ }
+ catch (Exception ex)
+ {
+ System.err.println(messagePrefix + "Exception in DisThreadedNetIF send thread: " + ex.getLocalizedMessage());
}
}
try {
@@ -354,8 +360,9 @@ public class DisThreadedNetIF
addresses = nif.getInetAddresses();
while (addresses.hasMoreElements()) {
addr = addresses.nextElement();
- if (addr instanceof Inet4Address && !addr.isLoopbackAddress() && !addr.isLinkLocalAddress()) {
- System.out.println("Using network interface " + nif.getDisplayName());
+ if (addr instanceof Inet4Address && !addr.isLoopbackAddress() && !addr.isLinkLocalAddress())
+ {
+ System.out.println(messagePrefix + "Using network interface " + nif.getDisplayName());
return nif;
}
}
@@ -366,4 +373,20 @@ public class DisThreadedNetIF
}
return null;
}
+
+ /**
+ * @return the verbose
+ */
+ public boolean isVerbose()
+ {
+ return verbose;
+ }
+
+ /**
+ * @param verbose the verbose to set
+ */
+ public void setVerbose(boolean verbose)
+ {
+ this.verbose = verbose;
+ }
}
diff --git a/src/edu/nps/moves/dis7/utilities/PduFactory.java b/src/edu/nps/moves/dis7/utilities/PduFactory.java
index 106f2ae81f..3ffc017c4c 100644
--- a/src/edu/nps/moves/dis7/utilities/PduFactory.java
+++ b/src/edu/nps/moves/dis7/utilities/PduFactory.java
@@ -218,7 +218,7 @@ public class PduFactory
/**
* Create an Entity State PDU<br>
* IEEE Std 1278.1-2012, 5.3.2
- * @return the pdu
+ * @return the new pdu
*/
public EntityStatePdu makeEntityStatePdu()
{
@@ -241,7 +241,7 @@ public class PduFactory
/**
* Create a Fire PDU<br>
* IEEE Std 1278.1-2012, 5.4.3
- * @return the pdu
+ * @return the new pdu
*/
public FirePdu makeFirePdu()
{
@@ -260,7 +260,7 @@ public class PduFactory
/**
* Create a Detonation PDU<br>
* IEEE Std 1278.1-2012, 5.4.4
- * @return the pdu
+ * @return the new pdu
*/
public DetonationPdu makeDetonationPdu()
{
@@ -276,7 +276,7 @@ public class PduFactory
/**
* Create a Collision PDU<br>
* IEEE Std 1278.1-2012, 5.3.3
- * @return the pdu
+ * @return the new pdu
*/
public CollisionPdu makeCollisionPdu()
{
@@ -295,7 +295,7 @@ public class PduFactory
/**
* Create a Service Request PDU<br>
* IEEE Std 1278.1-2012, 5.5.5
- * @return the pdu
+ * @return the new pdu
*/
public ServiceRequestPdu makeServiceRequestPdu()
{
@@ -312,7 +312,7 @@ public class PduFactory
/**
* Create a Resupply Offer PDU<br>
* IEEE Std 1278.1-2012, 5.5.6
- * @return the pdu
+ * @return the new pdu
*/
public ResupplyOfferPdu makeResupplyOfferPdu()
{
@@ -326,7 +326,7 @@ public class PduFactory
/**
* Create a Resupply Received PDU<br>
* IEEE Std 1278.1-2012, 5.5.7
- * @return the pdu
+ * @return the new pdu
*/
public ResupplyReceivedPdu makeResupplyReceivedPdu()
{
@@ -340,7 +340,7 @@ public class PduFactory
/**
* Create a Resupply Cancel PDU<br>
* IEEE Std 1278.1-2012, 5.5.8
- * @return the pdu
+ * @return the new pdu
*/
public ResupplyCancelPdu makeResupplyCancelPdu()
{
@@ -354,7 +354,7 @@ public class PduFactory
/**
* Create a Repair Complete PDU<br>
* IEEE Std 1278.1-2012, 5.5.10
- * @return the pdu
+ * @return the new pdu
*/
public RepairCompletePdu makeRepairCompletePdu()
{
@@ -371,7 +371,7 @@ public class PduFactory
/**
* Create a Repair Response PDU<br>
* IEEE Std 1278.1-2012, 5.5.11
- * @return the pdu
+ * @return the new pdu
*/
public RepairResponsePdu makeRepairResponsePdu()
{
@@ -388,7 +388,7 @@ public class PduFactory
/**
* Create a Create Entity PDU<br>
* IEEE Std 1278.1-2012, 5.6.5.2
- * @return the pdu
+ * @return the new pdu
*/
public CreateEntityPdu makeCreateEntityPdu()
{
@@ -400,7 +400,7 @@ public class PduFactory
/**
* Create a Remove Entity PDU<br>
* IEEE Std 1278.1-2012, 5.6.5.3
- * @return the pdu
+ * @return the new pdu
*/
public RemoveEntityPdu makeRemoveEntityPdu()
{
@@ -414,7 +414,7 @@ public class PduFactory
/**
* Create a Start Resume PDU<br>
* IEEE Std 1278.1-2012, 5.6.5.4
- * @return the pdu
+ * @return the new pdu
*/
public StartResumePdu makeStartResumePdu()
{
@@ -426,7 +426,7 @@ public class PduFactory
/**
* Create a Stop Freeze PDU<br>
* IEEE Std 1278.1-2012, 5.6.5.5
- * @return the pdu
+ * @return the new pdu
*/
public StopFreezePdu makeStopFreezePdu()
{
@@ -442,7 +442,7 @@ public class PduFactory
/**
* Create an Acknowledge PDU<br>
* IEEE Std 1278.1-2012, 5.6.5.6
- * @return the pdu
+ * @return the new pdu
*/
public AcknowledgePdu makeAcknowledgePdu()
{
@@ -459,7 +459,7 @@ public class PduFactory
/**
* Create an Action Request PDU<br>
* IEEE Std 1278.1-2012, 5.6.5.7
- * @return the pdu
+ * @return the new pdu
*/
public ActionRequestPdu makeActionRequestPdu()
{
@@ -473,7 +473,7 @@ public class PduFactory
/**
* Create an Action Response PDU<br>
* IEEE Std 1278.1-2012, 5.6.5.8
- * @return the pdu
+ * @return the new pdu
*/
public ActionResponsePdu makeActionResponsePdu()
{
@@ -487,7 +487,7 @@ public class PduFactory
/**
* Create a Data Query PDU<br>
* IEEE Std 1278.1-2012, 5.6.5.9
- * @return the pdu
+ * @return the new pdu
*/
public DataQueryPdu makeDataQueryPdu()
{
@@ -499,7 +499,7 @@ public class PduFactory
/**
* Create a Set DataPDU<br>
* IEEE Std 1278.1-2012, 5.6.5.10
- * @return the pdu
+ * @return the new pdu
*/
public SetDataPdu makeSetDataPdu()
{
@@ -511,7 +511,7 @@ public class PduFactory
/**
* Create a Data PDU<br>
* IEEE Std 1278.1-2012, 5.6.5.11
- * @return the pdu
+ * @return the new pdu
*/
public DataPdu makeDataPdu()
{
@@ -523,7 +523,7 @@ public class PduFactory
/**
* Create an Event Report PDU<br>
* IEEE Std 1278.1-2012, 5.6.5.12
- * @return the pdu
+ * @return the new pdu
*/
public EventReportPdu makeEventReportPdu()
{
@@ -537,7 +537,7 @@ public class PduFactory
/**
* Create a Comment PDU<br>
* IEEE Std 1278.1-2012, 5.6.5.13
- * @return the pdu
+ * @return the new pdu
*/
public CommentPdu makeCommentPdu()
{
@@ -548,8 +548,8 @@ public class PduFactory
/**
* Create a Comment PDU containing the given String(s), variable record type = "OTHER"
- * @param comments
- * @return the pdu
+ * @param comments of interest
+ * @return the new pdu
*/
public CommentPdu makeCommentPdu(String ... comments)
{
@@ -559,8 +559,8 @@ public class PduFactory
/**
* Create a Comment PDU containing the given String(s) and variable record type
* @param typ VariableRecordType
- * @param comments
- * @return the pdu
+ * @param comments of interest
+ * @return the new pdu
*/
public CommentPdu makeCommentPdu(VariableRecordType typ, String... comments)
{
@@ -579,7 +579,7 @@ public class PduFactory
/**
* Create a Electromagnetic Emission (EE) PDU<br>
* IEEE Std 1278.1-2012, 5.7.3
- * @return the pdu
+ * @return the new pdu
*/
public ElectromagneticEmissionPdu makeElectronicEmissionsPdu()
{
@@ -595,7 +595,7 @@ public class PduFactory
/**
* Create a Designator PDU<br>
* IEEE Std 1278.1-2012, 5.7.4
- * @return the pdu
+ * @return the new pdu
*/
public DesignatorPdu makeDesignatorPdu()
{
@@ -616,7 +616,7 @@ public class PduFactory
/**
* Create a Transmitter PDU<br>
* IEEE Std 1278.1-2012, 5.8.3
- * @return the pdu
+ * @return the new pdu
*/
public TransmitterPdu makeTransmitterPdu()
{
@@ -638,7 +638,7 @@ public class PduFactory
/**
* Create a Signal PDU<br>
* IEEE Std 1278.1-2012, 5.7.4
- * @return the pdu
+ * @return the new pdu
*/
public SignalPdu makeSignalPdu()
{
@@ -653,7 +653,7 @@ public class PduFactory
/**
* Create a Receiver PDU<br>
* IEEE Std 1278.1-2012, 5.8.5
- * @return the pdu
+ * @return the new pdu
*/
public ReceiverPdu makeReceiverPdu()
{
@@ -669,7 +669,7 @@ public class PduFactory
/**
* Create a an Identification Friend or Foe (IFF) PDU<br>
* IEEE Std 1278.1-2012, 5.7.6
- * @return the pdu
+ * @return the new pdu
*/
public IFFPdu makeIffPdu()
{
@@ -688,7 +688,7 @@ public class PduFactory
/**
* Create a Designator PDU<br>
* IEEE Std 1278.1-2012, 5.7.4
- * @return the pdu
+ * @return the new pdu
*/
public UnderwaterAcousticPdu makeUnderwaterAcousticPdu()
{
@@ -705,7 +705,7 @@ public class PduFactory
/**
* Create a Supplemental Emission/Entity State (SEES) PDU<br>
* IEEE Std 1278.1-2012, 5.7.7
- * @return the pdu
+ * @return the new pdu
*/
public SEESPdu makeSeesPdu()
{
@@ -717,7 +717,7 @@ public class PduFactory
/**
* Create an Intercom Signal PDU<br>
* IEEE Std 1278.1-2012, 5.8.6
- * @return the pdu
+ * @return the new pdu
*/
public IntercomSignalPdu makeIntercomSignalPdu()
{
@@ -729,7 +729,7 @@ public class PduFactory
/**
* Create an Intercom Control PDU<br>
* IEEE Std 1278.1-2012, 5.8.7
- * @return the pdu
+ * @return the new pdu
*/
public IntercomControlPdu makeIntercomControlPdu()
{
@@ -746,7 +746,7 @@ public class PduFactory
/**
* Create a Designator PDU<br>
* IEEE Std 1278.1-2012, 5.7.4
- * @return the pdu
+ * @return the new pdu
*/
public AggregateStatePdu makeAggregateStatePdu()
{
@@ -764,7 +764,7 @@ public class PduFactory
/**
* Create an IsGroupOf PDU<br>
* IEEE Std 1278.1-2012, 5.9.3
- * @return the pdu
+ * @return the new pdu
*/
public IsGroupOfPdu makeIsGroupOfPdu()
{
@@ -779,7 +779,7 @@ public class PduFactory
/**
* Create a Transfer Ownership PDU<br>
* IEEE Std 1278.1-2012, 5.9.4
- * @return the pdu
+ * @return the new pdu
*/
public TransferOwnershipPdu makeTransferOwnershipPdu()
{
@@ -798,7 +798,7 @@ public class PduFactory
/**
* Create an IsPartOf PDU<br>
* IEEE Std 1278.1-2012, 5.9.5
- * @return the pdu
+ * @return the new pdu
*/
public IsPartOfPdu makeIsPartOfPdu()
{
@@ -817,7 +817,7 @@ public class PduFactory
/**
* Create a Minefield State PDU<br>
* IEEE Std 1278.1-2012, 5.10.2
- * @return the pdu
+ * @return the new pdu
*/
public MinefieldStatePdu makeMinefieldStatePdu()
{
@@ -837,7 +837,7 @@ public class PduFactory
/**
* Create a Minefield Query PDU<br>
* IEEE Std 1278.1-2012, 5.10.3
- * @return the pdu
+ * @return the new pdu
*/
public MinefieldQueryPdu makeMinefieldQueryPdu()
{
@@ -854,7 +854,7 @@ public class PduFactory
/**
* Create a Minefield Data PDU<br>
* IEEE Std 1278.1-2012, 5.10.4
- * @return the pdu
+ * @return the new pdu
*/
public MinefieldDataPdu makeMinefieldDataPdu()
{
@@ -874,7 +874,7 @@ public class PduFactory
/**
* Create a Minefield Response Negative Acknowledgment (NACK) PDU<br>
* IEEE Std 1278.1-2012, 5.10.5
- * @return the pdu
+ * @return the new pdu
*/
public MinefieldResponseNACKPdu makeMinefieldResponseNackPdu()
{
@@ -886,7 +886,7 @@ public class PduFactory
/**
* Create an Environmental Process PDU<br>
* IEEE Std 1278.1-2012, 5.11.2.2
- * @return the pdu
+ * @return the new pdu
*/
public EnvironmentalProcessPdu makeEnvironmentalProcessPdu()
{
@@ -903,7 +903,7 @@ public class PduFactory
/**
* Create a Gridded Data PDU<br>
* IEEE Std 1278.1-2012, 5.11.2.3
- * @return the pdu
+ * @return the new pdu
*/
public GriddedDataPdu makeGriddedDataPdu()
{
@@ -922,7 +922,7 @@ public class PduFactory
/**
* Create a Point Object State PDU<br>
* IEEE Std 1278.1-2012, 5.11.3.2
- * @return the pdu
+ * @return the new pdu
*/
public PointObjectStatePdu makePointObjectStatePdu()
{
@@ -943,7 +943,7 @@ public class PduFactory
/**
* Create a Linear Object State PDU<br>
* IEEE Std 1278.1-2012, 5.11.3.3
- * @return the pdu
+ * @return the new pdu
*/
public LinearObjectStatePdu makeLinearObjectStatePdu()
{
@@ -962,7 +962,7 @@ public class PduFactory
/**
* Create an Areal Object State PDU<br>
* IEEE Std 1278.1-2012, 5.11.3.4
- * @return the pdu
+ * @return the new pdu
*/
public ArealObjectStatePdu makeArealObjectStatePdu()
{
@@ -979,7 +979,7 @@ public class PduFactory
/**
* Create a Time Space Position Information (TSPI) PDU<br>
* IEEE Std 1278.1-2012, 9.4.2
- * @return the pdu
+ * @return the new pdu
*/
public TSPIPdu makeTspiPdu()
{
@@ -999,7 +999,7 @@ public class PduFactory
/**
* Create an Appearance PDU<br>
* IEEE Std 1278.1-2012, 9.4.3
- * @return the pdu
+ * @return the new pdu
*/
public AppearancePdu makeAppearancePdu()
{
@@ -1019,7 +1019,7 @@ public class PduFactory
/**
* Create an Articulated Parts PDU<br>
* IEEE Std 1278.1-2012, 9.4.4
- * @return the pdu
+ * @return the new pdu
*/
public ArticulatedPartsPdu makeArticulatedPartsPdu()
{
@@ -1032,7 +1032,7 @@ public class PduFactory
/**
* Create a Live Entity (LE) Fire PDU<br>
* IEEE Std 1278.1-2012, 9.4.5
- * @return the pdu
+ * @return the new pdu
*/
public LEFirePdu makeLEFirePdu()
{
@@ -1053,7 +1053,7 @@ public class PduFactory
/**
* Create a Live Entity (LE) Detonation PDU<br>
* IEEE Std 1278.1-2012, 9.4.6
- * @return the pdu
+ * @return the new pdu
*/
public LEDetonationPdu makeLEDetonationPdu()
{
@@ -1076,7 +1076,7 @@ public class PduFactory
/**
* Create a Create Entity-R (Reliable) PDU<br>
* IEEE Std 1278.1-2012, 5.12.4.2
- * @return the pdu
+ * @return the new pdu
*/
public CreateEntityReliablePdu makeCreateEntityReliablePdu()
{
@@ -1092,7 +1092,7 @@ public class PduFactory
/**
* Create a Remove Entity-R (Reliable) PDU<br>
* IEEE Std 1278.1-2012, 5.12.4.3
- * @return the pdu
+ * @return the new pdu
*/
public RemoveEntityReliablePdu makeRemoveEntityReliablePdu()
{
@@ -1106,7 +1106,7 @@ public class PduFactory
/**
* Create a Start/Resume-R (Reliable) PDU<br>
* IEEE Std 1278.1-2012, 5.12.4.4
- * @return the pdu
+ * @return the new pdu
*/
public StartResumeReliablePdu makeStartResumeReliablePdu()
{
@@ -1122,7 +1122,7 @@ public class PduFactory
/**
* Create a Stop/Freeze-R (Reliable) PDU<br>
* IEEE Std 1278.1-2012, 5.12.4.5
- * @return the pdu
+ * @return the new pdu
*/
public StopFreezeReliablePdu makeStopFreezeReliablePdu()
{
@@ -1139,7 +1139,7 @@ public class PduFactory
/**
* Create an Acknowledge-R (Reliable) PDU<br>
* IEEE Std 1278.1-2012, 5.12.4.6
- * @return the pdu
+ * @return the new pdu
*/
public AcknowledgeReliablePdu makeAcknowledgeReliablePdu()
{
@@ -1156,7 +1156,7 @@ public class PduFactory
/**
* Create an Action Request-R (Reliable) PDU<br>
* IEEE Std 1278.1-2012, 5.12.4.7
- * @return the pdu
+ * @return the new pdu
*/
public ActionRequestReliablePdu makeActionRequestReliablePdu()
{
@@ -1171,7 +1171,7 @@ public class PduFactory
/**
* Create an Action Response-R (Reliable) PDU<br>
* IEEE Std 1278.1-2012, 5.12.4.8
- * @return the pdu
+ * @return the new pdu
*/
public ActionResponseReliablePdu makeActionResponseReliablePdu()
{
@@ -1185,7 +1185,7 @@ public class PduFactory
/**
* Create a Data Query-R (Reliable) PDU<br>
* IEEE Std 1278.1-2012, 5.12.4.9
- * @return the pdu
+ * @return the new pdu
*/
public DataQueryReliablePdu makeDataQueryReliablePdu()
{
@@ -1201,7 +1201,7 @@ public class PduFactory
/**
* Create a Set Data-R (Reliable) PDU<br>
* IEEE Std 1278.1-2012, 5.12.4.10
- * @return the pdu
+ * @return the new pdu
*/
public SetDataReliablePdu makeSetDataReliablePdu()
{
@@ -1217,7 +1217,7 @@ public class PduFactory
/**
* Create a Data-R (Reliable) PDU<br>
* IEEE Std 1278.1-2012, 5.12.4.11
- * @return the pdu
+ * @return the new pdu
*/
public DataReliablePdu makeDataReliablePdu()
{
@@ -1233,7 +1233,7 @@ public class PduFactory
/**
* Create an Event Report-R (Reliable) PDU<br>
* IEEE Std 1278.1-2012, 5.12.4.12
- * @return the pdu
+ * @return the new pdu
*/
public EventReportReliablePdu makeEventReportReliablePdu()
{
@@ -1247,7 +1247,7 @@ public class PduFactory
/**
* Create a Comment-R (Reliable) PDU<br>
* IEEE Std 1278.1-2012, 5.12.4.13
- * @return the pdu
+ * @return the new pdu
*/
public CommentReliablePdu makeCommentReliablePdu()
{
@@ -1258,8 +1258,8 @@ public class PduFactory
/**
* Create a Comment-R PDU containing the given String(s), variable record type = "OTHER"
- * @param comments
- * @return the pdu
+ * @param comments of interest
+ * @return the new pdu
*/
public CommentReliablePdu makeCommentReliablePdu(String ... comments)
{
@@ -1269,8 +1269,8 @@ public class PduFactory
/**
* Create a CommentR PDU containing the given String(s) and variable record type
* @param typ VariableRecordType
- * @param comments
- * @return the pdu
+ * @param comments of interest
+ * @return the new pdu
*/
public CommentReliablePdu makeCommentReliablePdu(VariableRecordType typ, String... comments)
{
@@ -1289,7 +1289,7 @@ public class PduFactory
/**
* Create a Record-R (Reliable) PDU<br>
* IEEE Std 1278.1-2012, 5.12.4.16
- * @return the pdu
+ * @return the new pdu
*/
public RecordReliablePdu makeRecordReliablePdu()
{
@@ -1304,7 +1304,7 @@ public class PduFactory
/**
* Create a Set Record-R (Reliable) PDU<br>
* IEEE Std 1278.1-2012, 5.12.4.15
- * @return the pdu
+ * @return the new pdu
*/
public SetRecordReliablePdu makeSetRecordReliablePdu()
{
@@ -1318,7 +1318,7 @@ public class PduFactory
/**
* Create a Record Query-R (Reliable) PDU<br>
* IEEE Std 1278.1-2012, 5.12.4.14
- * @return the pdu
+ * @return the new pdu
*/
public RecordQueryReliablePdu makeRecordQueryReliablePdu()
{
@@ -1333,7 +1333,7 @@ public class PduFactory
/**
* Create a Collision-Elastic PDU<br>
* IEEE Std 1278.1-2012, 5.3.4
- * @return the pdu
+ * @return the new pdu
*/
public CollisionElasticPdu makeCollisionElasticPdu()
{
@@ -1344,7 +1344,7 @@ public class PduFactory
/**
* Create a Entity State Update PDU<br>
* IEEE Std 1278.1-2012, 5.3.5
- * @return the pdu
+ * @return the new pdu
*/
public EntityStateUpdatePdu makeEntityStateUpdatePdu()
{
@@ -1361,7 +1361,7 @@ public class PduFactory
/**
* Create a Directed Energy (DE) Fire PDU<br>
* IEEE Std 1278.1-2012, 5.4.5
- * @return the pdu
+ * @return the new pdu
*/
public DirectedEnergyFirePdu makeDirectedEnergyFirePdu()
{
@@ -1380,7 +1380,7 @@ public class PduFactory
/**
* Create a Collision-Elastic PDU<br>
* IEEE Std 1278.1-2012, 5.3.3
- * @return the pdu
+ * @return the new pdu
*/
public EntityDamageStatusPdu makeEntityDamageStatusPdu()
{
@@ -1391,7 +1391,7 @@ public class PduFactory
/**
* Create an Information Operations (IO) Action PDU<br>
* IEEE Std 1278.1-2012, 5.13.3
- * @return the pdu
+ * @return the new pdu
*/
public InformationOperationsActionPdu makeInformationOperationsActionPdu()
{
@@ -1411,7 +1411,7 @@ public class PduFactory
/**
* Create an Information Operations (IO) Report PDU<br>
* IEEE Std 1278.1-2012, 5.13.4
- * @return the pdu
+ * @return the new pdu
*/
public InformationOperationsReportPdu makeInformationOperationsReportPdu()
{
@@ -1430,7 +1430,7 @@ public class PduFactory
/**
* Create an Attribute PDU<br>
* IEEE Std 1278.1-2012, 5.3.6
- * @return the pdu
+ * @return the new pdu
*/
public AttributePdu makeAttributePdu()
{
diff --git a/src/edu/nps/moves/dis7/utilities/stream/X3dCoordinates.java b/src/edu/nps/moves/dis7/utilities/stream/X3dCoordinates.java
index a0b814e602..9f64f1c298 100644
--- a/src/edu/nps/moves/dis7/utilities/stream/X3dCoordinates.java
+++ b/src/edu/nps/moves/dis7/utilities/stream/X3dCoordinates.java
@@ -22,12 +22,12 @@ public class X3dCoordinates {
/**
*
- * @param x
- * @param y
- * @param z
- * @param phi
- * @param psi
- * @param theta
+ * @param x coordinate
+ * @param y coordinate
+ * @param z coordinate
+ * @param phi orientation
+ * @param psi orientation
+ * @param theta orientation
*/
public X3dCoordinates(double x, double y, double z, double phi, double psi, double theta) {
this.x= x;
diff --git a/test/edu/nps/moves/dis7/CommentPdusTest.java b/test/edu/nps/moves/dis7/CommentPdusTest.java
index c376e8155f..3f65371eef 100644
--- a/test/edu/nps/moves/dis7/CommentPdusTest.java
+++ b/test/edu/nps/moves/dis7/CommentPdusTest.java
@@ -13,9 +13,9 @@ import static org.junit.jupiter.api.Assertions.*;
@DisplayName("Comment Pdus Test")
public class CommentPdusTest
{
- DisThreadedNetIF netif;
- Pdu receivedPdu;
- DisThreadedNetIF.PduListener lis;
+ DisThreadedNetIF disThreadedNetworkInterface;
+ Pdu receivedPdu;
+ DisThreadedNetIF.PduListener pduListener;
@BeforeAll
public static void setUpClass()
@@ -31,22 +31,22 @@ public class CommentPdusTest
@BeforeEach
public void setUp()
{
- netif = new DisThreadedNetIF();
- lis = new DisThreadedNetIF.PduListener() {
+ disThreadedNetworkInterface = new DisThreadedNetIF();
+ pduListener = new DisThreadedNetIF.PduListener() {
@Override
- public void incomingPdu(Pdu pdu) {
- setUpReceiver(pdu);
+ public void incomingPdu(Pdu newPdu) {
+ setUpReceiver(newPdu);
}
};
- netif.addListener(lis);
+ disThreadedNetworkInterface.addListener(pduListener);
}
@AfterEach
public void tearDown()
{
- netif.removeListener(lis);
- netif.kill();
- netif = null;
+ disThreadedNetworkInterface.removeListener(pduListener);
+ disThreadedNetworkInterface.kill();
+ disThreadedNetworkInterface = null;
}
@Test
@@ -76,7 +76,7 @@ public class CommentPdusTest
private void sendPdu(Pdu pdu)
{
try {
- netif.send(pdu);
+ disThreadedNetworkInterface.send(pdu);
Thread.sleep(100l);
}
catch (InterruptedException ex) {
@@ -90,16 +90,17 @@ public class CommentPdusTest
return pdu1.equals(pdu2);
}
- private void setUpReceiver(Pdu pdu)
+ private void setUpReceiver(Pdu newPdu)
{
- receivedPdu = pdu;
+ receivedPdu = newPdu;
}
public static void main(String[] args)
{
- CommentPdusTest cpt = new CommentPdusTest();
- cpt.setUp();
- cpt.testRoundTrip();
- cpt.tearDown();
+ CommentPdusTest commentPdusTest = new CommentPdusTest();
+
+ commentPdusTest.setUp();
+ commentPdusTest.testRoundTrip();
+ commentPdusTest.tearDown();
}
}
--
GitLab