[Moss-devel] CVS: moss/colpatik/include/modules/input ColpatikDevice.h,1.4,1.5 ColpatikInput.h,1.3,1.4 Device.h,1.4,1.5 DeviceInterrupt.h,1.4,1.5 DevicePoll.h,1.3,1.4 DeviceQuery.h,1.3,1.4 Event.h,1.6,1.7 Queue.h,1.4,1.5

[Alexander Feder <address@hidden>]

Update of /cvsroot/moss/moss/colpatik/include/modules/input
In directory subversions:/tmp/cvs-serv19556/include/modules/input

Modified Files:
        ColpatikDevice.h ColpatikInput.h Device.h DeviceInterrupt.h 
        DevicePoll.h DeviceQuery.h Event.h Queue.h 
Log Message:
added some doxygen stuff


Index: ColpatikDevice.h
===================================================================
RCS file: /cvsroot/moss/moss/colpatik/include/modules/input/ColpatikDevice.h,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -r1.4 -r1.5
*** ColpatikDevice.h    30 Oct 2002 23:35:53 -0000      1.4
--- ColpatikDevice.h    4 Dec 2002 15:48:14 -0000       1.5
***************
*** 35,38 ****
--- 35,43 ----
  #define __COLPATIK_DEVICE_H
  
+ /**
+  * @file
+  * Colpatik Device.
+  */
+ 
  #if _MSC_VER >= 1000
  #  pragma once
***************
*** 49,60 ****
  namespace colpatik
    {
!   
    class CColpatikDevice
      {
      public:
                 CColpatikDevice();
        virtual ~CColpatikDevice();
  
      protected:
        void Initialize();
  
--- 54,76 ----
  namespace colpatik
    {
! /** 
!  * Colpatik Device. TODO a more detailed description
!  */
    class CColpatikDevice
      {
      public:
+                /**
+                 * Constructor.
+                 */
                 CColpatikDevice();
+                /**
+                 * Destructor.
+                 */
        virtual ~CColpatikDevice();
  
      protected:
+       /**
+        * Initialization.
+        */
        void Initialize();
  

Index: ColpatikInput.h
===================================================================
RCS file: /cvsroot/moss/moss/colpatik/include/modules/input/ColpatikInput.h,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -r1.3 -r1.4
*** ColpatikInput.h     30 Oct 2002 23:35:53 -0000      1.3
--- ColpatikInput.h     4 Dec 2002 15:48:14 -0000       1.4
***************
*** 35,38 ****
--- 35,43 ----
  #define __COLPATIK_INPUT_H
  
+ /**
+  * @file 
+  * Colpatik Input.
+  */
+ 
  #if _MSC_VER >= 1000
  #  pragma once
***************
*** 57,60 ****
--- 62,68 ----
    typedef std::list<colpatik::CDevice*> CListPDevice;
  
+ /**
+  * Colpatik Input. TODO more detailed.
+  */
    class CColpatikInput  
      {
***************
*** 65,84 ****
--- 73,129 ----
  
      private:
+       /**
+        * what happens in action?? TODO.
+        * @param pData the data in action? TODO.
+        */
        static void Action(void* pData);
  
      public:
+             /**
+              * Constructor.
+              */
                 CColpatikInput();
+             /**
+              * Destructor.
+              */
        virtual ~CColpatikInput();
  
+       /**
+        * Add a driver.
+        * @return success TODO.
+        * @param sDriver name of driver to add TODO.
+        */
        bool               DriverAdd   (const std::string& sDriver);
+       /**
+        * Remove a driver.
+        * @return success TODO.
+        * @param sDriver name of driver to remove TODO.
+        */
        bool               DriverRemove(const std::string& sDriver);
+       /**
+        * Get the List of Drivers.
+        * @return A List of Strings TODO link auf liste.
+        */
        const CListString& DriverList  ();
  
+       /**
+        * Load Devices.
+        */
        void LoadDevices();
+       /**
+        * Run.
+        */
        void Run();
  
  
      protected:
+       /**
+        * Initialization.
+        */
        void Initialize();
+       /**
+        * Load Drivers.
+        * @return success TODO.
+        */
        bool DriversLoad();
      

Index: Device.h
===================================================================
RCS file: /cvsroot/moss/moss/colpatik/include/modules/input/Device.h,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -r1.4 -r1.5
*** Device.h    30 Oct 2002 23:35:53 -0000      1.4
--- Device.h    4 Dec 2002 15:48:14 -0000       1.5
***************
*** 31,34 ****
--- 31,39 ----
  #define __DEVICE_H
  
+ /**
+  * @file 
+  * Device.
+  */
+ 
  #if _MSC_VER >= 1000
  #  pragma once
***************
*** 51,55 ****
  namespace colpatik
    {
! 
    class CDevice
      {
--- 56,62 ----
  namespace colpatik
    {
! /**
!  * The Device Class. TODO more detailed.
!  */
    class CDevice
      {
***************
*** 64,68 ****
--- 71,82 ----
        
      public:
+              /**
+               * Constructor.
+               * @param rsURI keine ahnung TODO.
+               */
                 CDevice(const std::string& rsURI = "");
+              /**
+               * Destructor.
+               */
        virtual ~CDevice();
  
***************
*** 76,98 ****
  
        // abstract Interface
        virtual long   GetVersion() = 0;
        virtual long   GetType() = 0;
        virtual double GetPollingIntervall() = 0;
        virtual long   GetCapabilities() = 0;
        virtual long   GetFunctions() = 0;
        virtual void   GetInfo(long& rnVersion,
                               long& rnType,
                               long& rnCapabilities,
                               long& rnFunctions) = 0;
        virtual long   GetData(TDeviceData& rstData) = 0;
  
      public:
        // virtual Interface
        virtual long GetErrorLast();
        virtual long GetErrorText(std::string& rsError,
                                       long    nError = 0);
! 
        virtual bool CallbackRegister(const pfnDeviceCallback fnCallback,
                                            char              cType = CB_DATA);
        virtual void CallbackFree    (const pfnDeviceCallback fnCallback);
  
--- 90,163 ----
  
        // abstract Interface
+       /**
+        * Get the Version.
+        * @return the version.
+        */
        virtual long   GetVersion() = 0;
+       /**
+        * Get the type.
+        * @return the type.
+        */
        virtual long   GetType() = 0;
+       /**
+        * Get Polling Intervall.
+        * @return the polling interval.
+        */
        virtual double GetPollingIntervall() = 0;
+       /**
+        * Get the capabilities.
+        * @return capabilities TODO.
+        */
        virtual long   GetCapabilities() = 0;
+       /**
+        * Get the functions.
+        * @return functions TODO.
+        */
        virtual long   GetFunctions() = 0;
+       /**
+        * Get Information.
+        * @param rnVersion version.
+        * @param rnType type.
+        * @param rnCapabilities capabilities.
+        * @param rnFunctions functions.
+        */
        virtual void   GetInfo(long& rnVersion,
                               long& rnType,
                               long& rnCapabilities,
                               long& rnFunctions) = 0;
+       /**
+        * Get Data.
+        * @param rstData reference to where the data shall be written TODO.
+        * @return success TODO.
+        */
        virtual long   GetData(TDeviceData& rstData) = 0;
  
      public:
        // virtual Interface
+       /**
+        * Get Last Error.
+        * @return Number of Error TODO.
+        */
        virtual long GetErrorLast();
+       /**
+        * Get Error-Text.
+        * @param rsError string where the text shall be written into.
+        * @param nError number of error whose text is of interest.
+        * @return what TODO.
+        */
        virtual long GetErrorText(std::string& rsError,
                                       long    nError = 0);
!       /**
!        * Register Callbacks.
!        * @param fnCallback The Callback-fpn.
!        * @param cType the type of the callback's parameter TODO.
!        * @return success TODO.
!        */
        virtual bool CallbackRegister(const pfnDeviceCallback fnCallback,
                                            char              cType = CB_DATA);
+       /**
+        * Free a Callback.
+        * @param fnCallback the callback to be freed.
+        */
        virtual void CallbackFree    (const pfnDeviceCallback fnCallback);
  

Index: DeviceInterrupt.h
===================================================================
RCS file: /cvsroot/moss/moss/colpatik/include/modules/input/DeviceInterrupt.h,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -r1.4 -r1.5
*** DeviceInterrupt.h   30 Oct 2002 23:35:53 -0000      1.4
--- DeviceInterrupt.h   4 Dec 2002 15:48:14 -0000       1.5
***************
*** 31,34 ****
--- 31,39 ----
  #define __DEVICE_INTERRUPT_H
  
+ /**
+  * @file
+  * Device Interrupt.
+  */
+ 
  #if _MSC_VER >= 1000
  #  pragma once
***************
*** 47,51 ****
  namespace colpatik
    {
!   
    class CDeviceInterrupt : public CDevice
      {
--- 52,58 ----
  namespace colpatik
    {
!   /**
!    * The DeviceInterrupt Class. TODO A detailed description.
!    */
    class CDeviceInterrupt : public CDevice
      {
***************
*** 57,61 ****
--- 64,75 ----
        
      public:
+             /**
+              * Constructor.
+              * @param rsURI was auch immer TODO.
+              */
                 CDeviceInterrupt(const std::string& rsURI = "");
+             /**
+              * Destructor.
+              */
        virtual ~CDeviceInterrupt();
  

Index: DevicePoll.h
===================================================================
RCS file: /cvsroot/moss/moss/colpatik/include/modules/input/DevicePoll.h,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -r1.3 -r1.4
*** DevicePoll.h        30 Oct 2002 23:35:53 -0000      1.3
--- DevicePoll.h        4 Dec 2002 15:48:14 -0000       1.4
***************
*** 31,34 ****
--- 31,39 ----
  #define __DEVICE_POLL_H
  
+ /**
+  * @file
+  * Device Poll.
+  */
+ 
  #if _MSC_VER >= 1000
  #  pragma once
***************
*** 47,51 ****
  namespace colpatik
    {
!   
    class CDevicePoll : public CDevice
      {
--- 52,58 ----
  namespace colpatik
    {
! /** 
!  * The Device Poll Class. TODO a detailed description.
!  */
    class CDevicePoll : public CDevice
      {
***************
*** 57,61 ****
--- 64,75 ----
        
      public:
+             /**
+              * Constructor.
+              * @param rsURI was auch immer TODO.
+              */
                 CDevicePoll(const std::string& rsURI = "");
+             /**
+              * Destructor.
+              */
        virtual ~CDevicePoll();
           

Index: DeviceQuery.h
===================================================================
RCS file: /cvsroot/moss/moss/colpatik/include/modules/input/DeviceQuery.h,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -r1.3 -r1.4
*** DeviceQuery.h       30 Oct 2002 23:35:53 -0000      1.3
--- DeviceQuery.h       4 Dec 2002 15:48:14 -0000       1.4
***************
*** 31,34 ****
--- 31,40 ----
  #define __DEVICE_QUERY_H
  
+ /**
+  * @file
+  * Device Query.
+  */
+ 
+ 
  #if _MSC_VER >= 1000
  #  pragma once
***************
*** 47,51 ****
  namespace colpatik
    {
!   
    class CDeviceQuery : public CDevice
      {
--- 53,59 ----
  namespace colpatik
    {
! /**
!  * The Device Query Class. TODO a detailed description.
!  */
    class CDeviceQuery : public CDevice
      {
***************
*** 57,61 ****
--- 65,76 ----
        
      public:
+             /**
+              * Constructor.
+              * @param rsURI keine ahnung TODO.
+              */
                 CDeviceQuery(const std::string& rsURI = "");
+             /**
+              * Destructor.
+              */
        virtual ~CDeviceQuery();
           //  virtual ~CDeviceQuery();

Index: Event.h
===================================================================
RCS file: /cvsroot/moss/moss/colpatik/include/modules/input/Event.h,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -r1.6 -r1.7
*** Event.h     30 Oct 2002 23:35:53 -0000      1.6
--- Event.h     4 Dec 2002 15:48:14 -0000       1.7
***************
*** 37,40 ****
--- 37,45 ----
  #define __EVENT_H
  
+ /**
+  * @file
+  * Event.
+  */
+ 
  #if _MSC_VER >= 1000
  #  pragma once
***************
*** 76,79 ****
--- 81,87 ----
  namespace colpatik
    {
+   /**
+    * The Event Types
+    */
    enum eEventTypes
      {
***************
*** 89,92 ****
--- 97,103 ----
      }; // enum eEventTypes
  
+ /**
+  * The Event Class. TODO more detailed.
+  */
    class CEvent : public TEvent
      {
***************
*** 98,104 ****
--- 109,129 ----
  
      public:
+             /**
+              * Constructor.
+              */
                 CEvent();
+             /**
+              * CopyConstructor.
+              * @param src the source.
+              */
                 CEvent(      CEvent& src);
+             /**
+              * CopyConstructor.
+              * @param src the source.
+              */
                 CEvent(const TEvent& src);
+             /**
+              * Destructor.
+              */
        virtual ~CEvent();
  
***************
*** 108,111 ****
--- 133,139 ----
  
      protected:
+       /**
+        * Initialization.
+        */
        void Initialize();
  

Index: Queue.h
===================================================================
RCS file: /cvsroot/moss/moss/colpatik/include/modules/input/Queue.h,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -r1.4 -r1.5
*** Queue.h     30 Oct 2002 23:35:53 -0000      1.4
--- Queue.h     4 Dec 2002 15:48:14 -0000       1.5
***************
*** 35,38 ****
--- 35,43 ----
  #define __QUEUE_H
  
+ /**
+  * @file
+  * Queue.
+  */
+ 
  #if _MSC_VER >= 1000
  #  pragma once
***************
*** 52,56 ****
  namespace colpatik
    {
! 
    class CQueue : public std::queue<TEvent>
      {
--- 57,63 ----
  namespace colpatik
    {
! /**
!  * The Queue Class. TODO more detailed.
!  */
    class CQueue : public std::queue<TEvent>
      {
***************
*** 58,68 ****
  
      public:
                 CQueue();
        virtual ~CQueue();
! 
        CEvent& operator << (CEvent& roEvent);
        CEvent& operator >> (CEvent& roEvent);
  
      protected:
        void Initialize();
  
--- 65,92 ----
  
      public:
+             /**
+              * Constructor.
+              */
                 CQueue();
+             /**
+              * Destructor.
+              */
        virtual ~CQueue();
!       /**
!        * Push Event TODO.
!        * @param roEvent the event to push TODO.
!        */
        CEvent& operator << (CEvent& roEvent);
+       /**
+        * Pop Event TODO.
+        * @param roEvent where the event shall be written into.
+        */
        CEvent& operator >> (CEvent& roEvent);
  
      protected:
+ 
+       /**
+        * Initialization.
+        */
        void Initialize();