Changeset 233 in tmcsimulator for branches/FEPSimulator/FEPSim.cpp

Timestamp:

11/13/2017 06:07:07 PM (8 years ago)

Author:

jtorres

Message:

FEPSim: finalized comments, added to both header and source files.

File:

• branches/FEPSimulator/FEPSim.cpp (modified) (6 diffs)

branches/FEPSimulator/FEPSim.cpp

@@ -1 +1 @@
 #include "FEPSim.h"
-#include <time.h>
-
+
+/**
+ * Constructor. Sets data values for RPC Client and socket server.
+ * 
+ * @param ATMSHost The IP of ATMS Server
+ * @param FEP RPC program number
+ * @param FEP RPC program revision number
+ * @param Socket Server listen port
+ */
 FEPSim::FEPSim(char * ATMShost, int FEP_PROG, int FEP_REV, int SOCK_PORT) {
     this->ATMSHost = ATMShost;
@@ -13 +20 @@
 }
 
+/**
+ * Destructor: closes the log file if open
+ */
 FEPSim::~FEPSim() {
     FEPLogFile.close();
 }
 
+/**
+ * Handler for the ATMS RPC Response (to the client RPC Call)
+ * @param response pointer to fep_reply struct
+ */
 void FEPSim::handleCallResponse(void *response) {
     // Failed RPC Call 
@@ -28 +42 @@
 }
 
+/**
+ * Sends an fep_reply for each station on the FEPLine. 
+ * Gets highway status from recieved socket msg.
+ * 
+ * @param buffer The recieved highway status msg.
+ */
 void FEPSim::sendReplys(char * buffer) {
     HighwaysParser highwaysParser = HighwaysParser(buffer);
@@ -106 +126 @@
 }
 
+/**
+ * Creates an RPC Client, and on successful creation, sends fep_replys to ATMS.
+ * @param The recieved highway status msg.
+ */
 void FEPSim::manageClientConnection(char * buffer) 
 {
@@ -120 +144 @@
 }
 
-
+/**
+  * Creates an RPC Client to the ATMS Server. If unsuccessful, returns false
+  * @return bool success
+  */
 bool FEPSim::createClient() {
     /* Create RPC Client to communicate with ATMS */
@@ -137 +164 @@
 }
 
+/**
+ * Creates a socket server and awaits the highway status message from the
+ * ATMS Driver. Upon receipt of the highway status message, creates an RPC
+ * client and sends the fep_replys to the ATMS.
+ */
 void FEPSim::runSockServer() {
     int sockfd, newsockfd, portno, clilen;