Changeset 642 for BAORadio/libindi/libindi/libs/indibase/defaultdriver.h

Timestamp:

Feb 24, 2012, 12:37:36 PM (12 years ago)

Author:

frichard

Message:

-Alignement des antennes
-Version 0.0.9 de libindi

File:

• BAORadio/libindi/libindi/libs/indibase/defaultdriver.h (modified) (5 diffs)

BAORadio/libindi/libindi/libs/indibase/defaultdriver.h

@@ +1 @@
+/*******************************************************************************
+  Copyright(c) 2011 Jasem Mutlaq. All rights reserved.
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Library General Public
+ License version 2 as published by the Free Software Foundation.
+
+ This library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ Library General Public License for more details.
+
+ You should have received a copy of the GNU Library General Public License
+ along with this library; see the file COPYING.LIB.  If not, write to
+ the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
+*******************************************************************************/
+
 #ifndef INDIDEFAULTDRIVER_H
 #define INDIDEFAULTDRIVER_H
@@ -5 +23 @@
 #include "indidriver.h"
 
+#include <auto_ptr.h>
+
+extern const char *COMMUNICATION_TAB;
+extern const char *MAIN_CONTROL_TAB;
+extern const char *MOTION_TAB;
+extern const char *DATETIME_TAB;
+extern const char *SITE_TAB;
+extern const char *OPTIONS_TAB;
+extern const char *FILTER_TAB;
+extern const char *GUIDER_TAB;
+
 /**
  * \class INDI::DefaultDriver
-   \brief Class to provide extended functionary for drivers in addition
+   \brief Class to provide extended functionality for drivers in addition
 to the functionality provided by INDI::BaseDriver. This class should \e only be subclassed by
 drivers directly as it is linked with main(). Virtual drivers cannot employ INDI::DefaultDriver.
@@ -21 +50 @@
 public:
     DefaultDriver();
-    virtual ~DefaultDriver() {}
+    virtual ~DefaultDriver();
 
     /** \brief Add Debug, Simulation, and Configuration options to the driver */
@@ -74 +103 @@
     virtual bool deleteProperty(const char *propertyName);
 
-    /** \brief Connect or Disconnect a device.
+
+    /** \brief Set connection switch status in the client.
       \param status If true, the driver will attempt to connect to the device (CONNECT=ON). If false, it will attempt
 to disconnect the device.
-      \param msg A message to be sent along with connect/disconnect command.
+      \param status True to set CONNECT on, false to set DISCONNECT on.
+      \param state State of CONNECTION properti, by default IPS_OK.
+      \param msg A message to be sent along with connect/disconnect command, by default NULL.
     */
     virtual void setConnected(bool status, IPState state=IPS_OK, const char *msg = NULL);
 
-    int SetTimer(int);
-    void RemoveTimer(int);
+    /** \brief Set a timer to call the function TimerHit after ms milliseconds
+        \param ms timer duration in milliseconds.
+        \return id of the timer to be used with RemoveTimer
+   */
+    int SetTimer(int ms);
+
+    /** \brief Remove timer added with SetTimer
+        \param id ID of the timer as returned from SetTimer
+   */
+    void RemoveTimer(int id);
+
+    /** \brief Callback function to be called once SetTimer duration elapses. */
     virtual void TimerHit();
 
@@ -116 +158 @@
         \return True if successful, false otherwise.
     */
-    bool loadConfig();
+    virtual bool loadConfig();
 
     /** \brief Save the current properties in a configuration file
         \return True if successful, false otherwise.
     */
-    bool saveConfig();
+    virtual bool saveConfig();
+    virtual bool saveConfigItems(FILE *fp);
 
     /** \brief Load the default configuration file
         \return True if successful, false otherwise.
     */
-    bool loadDefaultConfig();
+    virtual bool loadDefaultConfig();
+
 
     // Simulatin & Debug