Remove some extraneous output, add a few comments, tidy a bit of formatting

diff --git a/src/ATC/transmission.hxx b/src/ATC/transmission.hxx
index dbc0142010c63ea7b47533e92cfcf69530127eb7..02c0c050bb9e85f1996f907d3d7f9121f7ad9dcc 100644 (file)
--- a/src/ATC/transmission.hxx
+++ b/src/ATC/transmission.hxx
@@ -79,10 +79,10 @@ struct TransPar {
 // FGTransmission - a class to encapsulate a speech transmission
 class FGTransmission {
 
-  int       StationType;             // Type of ATC station: 1 Approach
-  TransCode Code;
-  string    TransText;
-  string    MenuText;
+  int       StationType;    // Type of ATC station: 1 Approach
+  TransCode Code;           // DCL - no idea what this is.
+  string    TransText;      // The text of the spoken transmission
+  string    MenuText;       // An abbreviated version of the text for the menu entry
 
 public:
 

diff --git a/src/ATC/transmissionlist.cxx b/src/ATC/transmissionlist.cxx
index e09dc6fd1b50849f77d644780fbe65a72d891078..d3fa44d4b938ae3d5f8856af22de640e47b88e37 100644 (file)
--- a/src/ATC/transmissionlist.cxx
+++ b/src/ATC/transmissionlist.cxx
@@ -89,21 +89,24 @@ bool FGTransmissionList::init( SGPath path ) {
 
     while ( ! in.eof() ) {
         in >> a;
-       transmissionlist_station[a.get_station()].push_back(a);
-       
+        transmissionlist_station[a.get_station()].push_back(a);
+
         in >> skipcomment;
 
-       if ( a.get_station() < min ) {
-         min = a.get_station();
-       }
-       if ( a.get_station() > max ) {
-         max = a.get_station();
-       }
-       cout << a.get_station() << " " << a.get_code().c1 << " " << a.get_code().c2 << " "
-            << a.get_code().c3 << " " << a.get_transtext() 
-            << " " << a.get_menutext() << endl;
+        if ( a.get_station() < min ) {
+            min = a.get_station();
+        }
+        if ( a.get_station() > max ) {
+            max = a.get_station();
+        }
+
+        /*
+        cout << a.get_station() << " " << a.get_code().c1 << " " << a.get_code().c2 << " "
+             << a.get_code().c3 << " " << a.get_transtext() 
+             << " " << a.get_menutext() << endl;
+        */
     }
-    
+ 
 #endif
 
     // init ATC menu
@@ -161,14 +164,15 @@ string FGTransmissionList::gen_text(const int &station, const TransCode code,
        for ( ; current != last ; ++current ) {
                if ( current->get_code().c1 == code.c1 &&  
                        current->get_code().c2 == code.c2 &&
-               current->get_code().c3 == code.c3 ) {
+                   current->get_code().c3 == code.c3 ) {
                        
                        if ( ttext ) message = current->get_transtext();
                        else message = current->get_menutext();
                        strcpy( &mes[0], message.c_str() ); 
                        
+                       // Replace all the '@' parameters with the actual text.
                        int check = 0;  // If mes gets overflowed the while loop can go infinite
-                       while ( strchr(&mes[0], crej) != NULL  ) {
+                       while ( strchr(&mes[0], crej) != NULL  ) {      // ie. loop until no more occurances of crej ('@') found
                                pos = strchr( &mes[0], crej );
                                bcopy(pos, &tag[0], 3);
                                tag[3] = '\0';

diff --git a/src/ATC/transmissionlist.hxx b/src/ATC/transmissionlist.hxx
index bec788b0cf93198cac670c42a6f7019fe717b301..935f9bf9986d583f52a7568bc7478b5ef56504dc 100644 (file)
--- a/src/ATC/transmissionlist.hxx
+++ b/src/ATC/transmissionlist.hxx
@@ -45,6 +45,7 @@ class FGTransmissionList {
   typedef transmission_list_type::iterator transmission_list_iterator;
   typedef transmission_list_type::const_iterator transmission_list_const_iterator;
   
+  // Map of transmission lists by station type
   // typedef map < int, transmission_list_type, less<int> > transmission_map_type;
   typedef map < int, transmission_list_type > transmission_map_type;
   typedef transmission_map_type::iterator transmission_map_iterator;
@@ -65,6 +66,8 @@ public:
 
   // generate the transmission text given the code of the message 
   // and the parameters
+  // Set ttext = true to generate the spoken transmission text, 
+  // or false to generate the abridged menu entry text.
   string gen_text(const int &station, const TransCode code,
                  const TransPar &tpars, const bool ttext);