Mario Bambagini / ssWi

Dependents:   rover_car rover_pc supervisor watering_unit ... more

Files at this revision

API Documentation at this revision

Comitter:
mariob
Date:
Thu Sep 06 12:11:52 2012 +0000
Parent:
2:5228774a6b99
Child:
4:dbbf82c966c2
Commit message:
doc

Changed in this revision

ssWiPort.hpp Show annotated file Show diff for this revision Revisions of this file
--- a/ssWiPort.hpp	Thu Sep 06 12:05:52 2012 +0000
+++ b/ssWiPort.hpp	Thu Sep 06 12:11:52 2012 +0000
@@ -8,19 +8,22 @@
 
 /** \brief Internal type which represents a logical flow
  *
- *  Ports are used internally to model a virtual memory are
- *  of the network
+ *  Ports are used internally to model a virtual memory are of the network.
+ *  Note that a port is a dual gate memory area which means that if you write
+ *  on it, the reading operation does not read that value but the one received
+ *  though the network
  */
 class ssWiPort
 {
-    //buffer for the receaving
+    /** receiving buffer */
     PortValue valueRX;
     Mutex mutexRX;
     
-    //buffer for the transmission
+    /** transmission buffer */
     PortValue valueTX;
     Mutex mutexTX;
-    
+
+    /** modification flag (true: someone has write a new value to be sent */    
     bool modified;