Changeset 69 in pacpusframework for trunk/include/Pacpus/PacpusTools/ShMemBase.h

Timestamp:

01/10/13 00:04:42 (11 years ago)

Author:

Marek Kurdej

Message:

Added: more documentation.

File:

• trunk/include/Pacpus/PacpusTools/ShMemBase.h (modified) (1 diff)

trunk/include/Pacpus/PacpusTools/ShMemBase.h

@@ -14 +14 @@
 #define DEF_PACPUS_SHMEMBASE_H
 
+/// Base class for shared memory objects.
 class ShMemBase
 {
 public:
-  ShMemBase()
-  {
-      /*printf("ShMemBase::ShMemBase() not implemented !\n");*/
-  }
+    /// Ctor
+    ShMemBase()
+    {
+    }
 
-  virtual ~ShMemBase()
-  {
-      /*printf("ShMemBase::~ShMemBase() not implemented !\n");*/
-  }
+    /// Dtor
+    virtual ~ShMemBase()
+    {
+    }
 
-  // Use this method to get the data of the shared memory
-  virtual void *read() = 0; 
+    /// Use this method to get the data of the shared memory
+    virtual void *read() = 0; 
 
-  // Use this method to write data in shared memory
-  virtual void write(void *data, int size, unsigned long offset = 0) = 0; 
+    /// Use this method to write data in shared memory
+    virtual void write(void *data, int size, unsigned long offset = 0) = 0; 
 
-  // Use this method to wait the incoming of new data
-  // you can specify a timeout in ms to avoid infinite blocking or 0 (infinite)
-  // return true if new data available before the timeout or else false
-  virtual bool wait(unsigned long timeout = 0) = 0; 
+    /// Use this method to wait the incoming of new data
+    /// you can specify a timeout in ms to avoid infinite blocking or 0 (infinite)
+    /// @returns @b true if new data available before the timeout, @b false otherwise
+    virtual bool wait(unsigned long timeout = 0) = 0; 
 
-  // To lock the access to the memory
-  virtual void lockMemory() = 0; 
+    /// To lock the access to the memory
+    virtual void lockMemory() = 0; 
 
-  // To unlock the access to the memory
-  virtual void unlockMemory() = 0; 
+    /// To unlock the access to the memory
+    virtual void unlockMemory() = 0; 
 
 #ifdef WIN32
-  // Return the event handle under Windows 
-  // ... under Linux ? 
-  virtual void * getEventIdentifier() = 0; 
+    /// Return the event handle under Windows 
+    /// @todo ... under Linux ? 
+    virtual void * getEventIdentifier() = 0; 
 #endif 
   
 protected:
-  void * shMem_; 
-        
+    /// @todo Documentation
+    void * shMem_;
+
 private:
 };