Merge pull request #20 from NetworkingDevs/version1_2_0

Version1 2 0

Author: HenilMistry

NS3-GUI.iml

@@ -18,6 +18,8 @@
     <orderEntry type="library" name="Maven: org.openjfx:javafx-graphics:win:21.0.1" level="project" />
     <orderEntry type="library" name="Maven: org.openjfx:javafx-base:21.0.1" level="project" />
     <orderEntry type="library" name="Maven: org.openjfx:javafx-base:win:21.0.1" level="project" />
+    <orderEntry type="library" name="Maven: org.apache.logging.log4j:log4j-api:2.23.1" level="project" />
+    <orderEntry type="library" name="Maven: org.apache.logging.log4j:log4j-core:2.23.1" level="project" />
     <orderEntry type="library" name="Maven: com.intellij:forms_rt:7.0.3" level="project" />
     <orderEntry type="library" name="Maven: asm:asm-commons:3.0" level="project" />
     <orderEntry type="library" name="Maven: asm:asm-tree:3.0" level="project" />

diagram.svg

@@ -21,6 +21,17 @@
             <artifactId>javafx-swing</artifactId>
             <version>21.0.1</version>
         </dependency>
+        <!-- for logging and all that stuff -->
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-api</artifactId>
+            <version>2.23.1</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-core</artifactId>
+            <version>2.23.1</version>
+        </dependency>
         <dependency>
             <groupId>com.intellij</groupId>
             <artifactId>forms_rt</artifactId>

pom.xml

@@ -1,11 +1,18 @@
 package Dialogs;
 
+import Helpers.LoggingHelper;
+import Helpers.PlaceHolderHelper;
+import org.jetbrains.annotations.Debug;
+
 import javax.swing.*;
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
 import java.util.ArrayList;
 import java.util.Map;
 
+/**
+ * to manage the configuration of one UDP Echo client
+ * */
 public class Dialog_ConfigureClient extends JFrame {
     private JPanel JPanel_main;
     private JLabel lbl_clientIndex;
@@ -22,18 +29,62 @@ public class Dialog_ConfigureClient extends JFrame {
     private JTextField textField_packets;
     private JButton btn_save;
 
+    /**
+     * placeholder for start time
+     * */
+    private static String PLACEHOLDER_START_TIME = "Enter start time";
+    /**
+     * placeholder for uptime
+     * */
+    private static String PLACEHOLDER_UP_TIME = "Enter total up time";
+    /**
+     * placeholder for MTU
+     * */
+    private static String PLACEHOLDER_MTU = "Enter the MTU";
+    /**
+     * placeholder for interval between two packets
+     * */
+    private static String PLACEHOLDER_INTERVAL = "Enter the interval";
+    /**
+     * placeholder for total packets to be sent
+     * */
+    private static String PLACEHOLDER_TOT_PACKETS = "Enter total packets";
     // mention all the components that have to be taken here....
+    /**
+     * the key for overview label
+     * */
     public static final String COMPONENT_OVERVIEW_LABEL = "Server_OverviewLabel";
 
     // for serving the functionalities....
+    /**
+     * the map for helpful components
+     * */
     Map<String, JComponent> helpfulComponents;
 
     // for serving the functionalities...
+    /**
+     * the total no. of nodes
+     * */
     int totalNodes;
+    /**
+     * the client configuration settings
+     * */
     public ArrayList<String> settings;
+    /**
+     * dialog helper
+     * */
     Dialog_Helper dialogHelper;
 
+
+    /**
+     * to create the object of type Dialog_ConfigureClient Server
+     *
+     * @param n total no. of nodes
+     * @param helpfulComponents the map of helpful components
+     * @since 0.3.0
+     * */
     public Dialog_ConfigureClient(int n, Map<String, JComponent> helpfulComponents) {
+        LoggingHelper.Log("Creating object of type Dialog_ConfigureClient");
         this.helpfulComponents = helpfulComponents;
         this.totalNodes = n;
         this.settings = new ArrayList<>();
@@ -42,15 +93,22 @@ public Dialog_ConfigureClient(int n, Map<String, JComponent> helpfulComponents)
         // initializing the components...
         this.setContentPane(this.JPanel_main);
         this.setTitle("Client Configuration");
-        this.setSize(400,275);
+        this.setSize(400,300);
         this.setVisible(false);
         this.setResizable(false);
         this.setDefaultCloseOperation(JFrame.HIDE_ON_CLOSE);
 
+        PlaceHolderHelper.addPlaceHolder(textField_startTime,PLACEHOLDER_START_TIME);
+        PlaceHolderHelper.addPlaceHolder(textField_upTime,PLACEHOLDER_UP_TIME);
+        PlaceHolderHelper.addPlaceHolder(textField_mtu,PLACEHOLDER_MTU);
+        PlaceHolderHelper.addPlaceHolder(textField_interval,PLACEHOLDER_INTERVAL);
+        PlaceHolderHelper.addPlaceHolder(textField_packets,PLACEHOLDER_TOT_PACKETS);
+
         // action to be performed when clicking on save settings button...
         btn_save.addActionListener(new ActionListener() {
             @Override
             public void actionPerformed(ActionEvent e) {
+                LoggingHelper.LogFunction("Saving the client configurations!");
                 // validate inputs...
                 if (validateInputs()) {
                     // and if all are valid then save settings...
@@ -69,50 +127,113 @@ public void actionPerformed(ActionEvent e) {
         });
     }
 
+    /**
+     * to make the dialog visible with list of all nodes
+     *
+     * @param b whether to show or hide
+     * @since 0.3.0
+     * */
     @Override
     public void setVisible(boolean b) {
         super.setVisible(b);
         if (b) {
+            LoggingHelper.LogFunction("Configure CLinet : Populating the dropdown items for all nodes.");
             for (int i=0; i<this.totalNodes; i++) {
                 this.comboBox_clientIndex.addItem("Node "+i);
             }
         }
     }
 
+    /**
+     * to show dialog with nodes
+     *
+     * @param n the total nodes
+     * @since 0.3.0
+     * */
     public void showDialog(int n) {
+        LoggingHelper.LogInfo("Configure Client : Setting total nodes!");
         this.totalNodes = n;
         this.setVisible(true);
     }
 
+    /**
+     * to get the stop time of the client
+     *
+     * @since 1.0.0
+     * */
     public int getStopTime() {
+        LoggingHelper.Log("Configure Client : Get Stop Time Called!");
         return Integer.parseInt(this.settings.get(1)) + Integer.parseInt(this.settings.get(2));
     }
 
+    /**
+     * to get the start time of the client
+     *
+     * @since 1.0.0
+     * */
     public String getStartTime() {
+        LoggingHelper.Log("Configure Client : Get Start Time Called!");
         return this.settings.get(1);
     }
 
+    /**
+     * to get the index of the client node
+     *
+     * @since 1.0.0
+     * */
     public String getClientIndex() {
+        LoggingHelper.Log("Configure Client : Get Client Index Called!");
         return this.settings.get(0);
     }
 
+    /**
+     * to get the MTU of the client
+     *
+     * @since 1.0.0
+     * */
     public String getMTU() {
+        LoggingHelper.Log("Configure Client : Get MTU Called!");
         return this.settings.get(3);
     }
 
+    /**
+     * to get the interval of the client
+     *
+     * @since 1.0.0
+     * */
     public String getInterval() {
+        LoggingHelper.Log("Configure Client : Get Interval Called!");
         return this.settings.get(4);
     }
 
+    /**
+     * to get the no. of packets for the client
+     *
+     * @since 1.0.0
+     * */
     public String getPackets() {
+        LoggingHelper.Log("Configure Client : Get Packets Called!");
         return this.settings.get(5);
     }
 
+    /**
+     * to update the overview text
+     *
+     * @since 0.3.0
+     * */
     private void updateOverviewTxt() {
+        LoggingHelper.Log("Configure Client : Changing the overview label!");
         ((JLabel)this.helpfulComponents.get(COMPONENT_OVERVIEW_LABEL)).setText("Client Index : Configured node "+this.settings.get(0));
     }
 
+    /**
+     * to validate the input settings
+     *
+     * @return the boolean value indicating the validity of the inputs
+     * @since 0.3.0
+     * */
     private boolean validateInputs() {
+        LoggingHelper.LogFunction("Configure Client : Validating all inputs");
 
         // start time validation...
         if (!textField_startTime.getText().chars().allMatch(Character::isDigit) || textField_startTime.getText().toString().length() == 0) {