Added javadoc comments to DetectedObjectInteraction and DetectorRegis…

…tration
usdot-fhwa-stol · Aug 1, 2023 · 35c45a5 · 35c45a5
1 parent 7c9b453
commit 35c45a5
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/...ons/src/main/java/org/eclipse/mosaic/interactions/detector/DetectedObjectInteraction.java b/...ons/src/main/java/org/eclipse/mosaic/interactions/detector/DetectedObjectInteraction.java
@@ -24,15 +24,28 @@ public class DetectedObjectInteraction extends Interaction {
 
     private DetectedObject detectedObject;
 
+    /**
+     * Constructor for DetectedObjectInteraction.
+     * @param time time for interaction.
+     * @param detectedObject detected object data for interaction.
+     */
     public DetectedObjectInteraction(long time, DetectedObject detectedObject) {
         super(time);
         this.detectedObject = detectedObject;
     }
 
+    /**
+     * Getter returns detected object.
+     * @return Detected Object
+     */
     public DetectedObject getDetectedObject() {
         return detectedObject;
     }
 
+    /**
+     * Set detected object.
+     * @param detectedObject 
+     */
     public void setDetectedObject(DetectedObject detectedObject) {
         this.detectedObject = detectedObject;
     }

diff --git a/...ractions/src/main/java/org/eclipse/mosaic/interactions/detector/DetectorRegistration.java b/...ractions/src/main/java/org/eclipse/mosaic/interactions/detector/DetectorRegistration.java
@@ -22,23 +22,38 @@ public class DetectorRegistration extends Interaction {
     public static final String TYPE_ID = createTypeIdentifier(DetectorRegistration.class);
 
     private Detector detector;
+    /**
+     * Constructor
+     * @param time for interaction.
+     * @param sensor to register.
+     */
     public DetectorRegistration(long time, Detector sensor) {
         super(time);
         this.detector = sensor;
     }
+    /**
+     * Getter for sensor/detector information.
+     * @return 
+     */
     public Detector getDetector() {
         return detector;
     }
+    /**
+     * Setter for sensor/detection information.
+     * @param sensor
+     */
     public void setDetector(Detector sensor) {
         this.detector = sensor;
     }
+
     @Override
     public int hashCode() {
         final int prime = 31;
         int result = super.hashCode();
         result = prime * result + ((detector == null) ? 0 : detector.hashCode());
         return result;
     }
+
     @Override
     public boolean equals(Object obj) {
         if (this == obj)