Reinserts original comments

qt6-after/qt6-migrated-legatus/TetraIF/PrtCnv/PrtCnvInjectionThread.hpp

@@ -1,15 +1,15 @@
-
-
-
-
-
-
-
-
-
-
-
-
+// **************************************************************************
+//
+//  (C) Copyright 2009   Swiss SIMTEC AG
+//
+// **************************************************************************
+//
+//  $HeadURL$
+//  $LastChangedBy$
+//  $LastChangedDate$
+//  $LastChangedRevision$
+//
+// **************************************************************************
  
 #pragma once
 
@@ -28,8 +28,16 @@ class CoPrtCnvCentralTelegram;
 namespace PrtCnv
 {
   class PrtCnvInjectionSocket;
-    
-
+    /**
+   * This class represents a thread, which acts as TCP-Server. The LogView-
+   * application can connect to it and send radio- or central-telegrams. The
+   * telegrams will be stored within this class and can be taken by another thread.
+   * This mechanism will be used for inject telegrams to protocol-converter.
+   * 
+   * @author alois.wismer
+   * @version 1.0
+   * @created 05-Aug-2010 11:17:06
+   */
   class PrtCnvInjectionThread : public PrtCnvThread
   {
     Q_OBJECT
@@ -37,8 +45,10 @@ namespace PrtCnv
 
     ~PrtCnvInjectionThread();
 
-    
-
+    /**
+     * 
+     * @param a_parent
+     */
     explicit PrtCnvInjectionThread(PrtCnvThreadStarter* a_parent);
 
 
@@ -47,31 +57,48 @@ namespace PrtCnv
 
     int32_t init() override;
 
-    
-
+    /**
+     * Starts the thread and listen for TCP-clients
+     */
     int32_t start() override;
 
-    
-
+    /**
+     * Returns the next central-telegram to be injected. It will automatically be
+     * taken out of the list.
+     * The caller is responsible to delete the telegram, if no longer used.
+     * Returns NULL if no central-telegram available
+     */
     N_CoPrtCnv::CoPrtCnvCentralTelegram *getNextCentralInjectionTelegram();
 
-    
-
+    /**
+     * Returns the next radio-telegram to be injected. It will automatically be taken
+     * out of the list.
+     * The caller is responsible to delete the telegram, if no longer used.
+     * Returns NULL if no radio-telegram available
+     */
     N_CoPrtCnv::CoPrtCnvCentralTelegram *getNextRadioInjectionTelegram();
 
-    
-
+    /**
+     * 
+     * @param a_telegram
+     */
     void addToCentralList(N_CoPrtCnv::CoPrtCnvCentralTelegram *a_telegram);
 
-    
-
+    /**
+     * 
+     * @param a_telegram
+     */
     void addToRadioList(N_CoPrtCnv::CoPrtCnvCentralTelegram *a_telegram);
 
-  protected:    
-
+  protected:    /**
+     * The port of the injection-server (configurable with key 'Port' in group
+     * [Injection])
+     */
     uint16_t m_Port;
-    
-
+    /**
+     * true if injection-server is enabled (configurable with key 'Enable' in group
+     * [Injection])
+     */
     bool m_Enabled;
     QTcpServer *m_Server;
 
@@ -89,11 +116,15 @@ namespace PrtCnv
 
 
   public slots:
-  
-
+  /**
+     * Connects a TCP-client
+     */
   void connectClient();
-  
-
+  /**
+     * Disconnects a TCP-client
+     *
+     * @param a_injectionSocket
+     */
   void disconnectClient(PrtCnvInjectionSocket* a_injectionSocket);
 
   };