Changeset 4016 in Sophya for trunk/AddOn/TAcq/racqueth.cc

Timestamp:

Aug 12, 2011, 2:26:10 PM (14 years ago)

Author:

ansari

Message:

Ajout de commentaires d'autodocumentation Doxygen, Reza 12/08/2011

File:

• trunk/AddOn/TAcq/racqueth.cc (modified) (2 diffs)

trunk/AddOn/TAcq/racqueth.cc

@@ -25 +25 @@
 // Classe thread de lecture PCI-Express et recopie sur interface reseau (Ethernet) 
 //----------------------------------------------------------------------------------------------------------
+
+/*!
+   \class PCIEToEthernet
+   \ingroup TAcq
+
+   \brief Performs data reception (DMA) on PCI-Express and sends data over ethernet (TCP/IP network interface) 
+
+   This class handles ethernet/network connections, reads data formatted as BRPaquet objects through PCI-Express DMA's
+   and sends the received data to EthernetReader over network/ethernet, \b without ging through the memory manager 
+   RAcqMemZoneMgr object. 
+*/
 
 // Si on veut avoir le protocole de controle (Hand-shake) entre l'emetteur et le recepteur,
@@ -435 +446 @@
 // Classe thread de lecture sur interface reseau (Ethernet) 
 //------------------------------------------------------------------
+/*!
+   \class EthernetReader
+   \ingroup TAcq
+
+   \brief Performs data reception (BRPaquet format) over ethernet (TCP/IP network interface) 
+
+   This class  ethernet/network connections, and reads data formatted as BRPaquet objects send by PCIEToEthernet objects.
+   Data is transferred to an RAcqMemZoneMgr object memory buffers. A single EthernetReader can handle multiple 
+   connections (data reception from several PCIEToEthernet senders) and can optionnaly synchronize data using the 
+   FrameCounter.
+*/
 
 /* --Methode-- */