Changeset 642 for BAORadio/libindi/libindi/libs/indibase/indifocuser.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/indifocuser.h (modified) (2 diffs)

BAORadio/libindi/libindi/libs/indibase/indifocuser.h

@@ -1 +1 @@
 /*******************************************************************************
-  Copyright(c) 2010 Gerry Rozema. All rights reserved.
+  Copyright(c) 2011 Gerry Rozema. All rights reserved.
 
-  This program is free software; you can redistribute it and/or modify it
-  under the terms of the GNU General Public License as published by the Free
-  Software Foundation; either version 2 of the License, or (at your option)
-  any later version.
+ 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 program 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 General Public License for
-  more details.
+ 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 General Public License along with
-  this program; if not, write to the Free Software Foundation, Inc., 59
-  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-
-  The full GNU General Public License is included in this distribution in the
-  file called LICENSE.
+ 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.
 *******************************************************************************/
 
@@ -25 +22 @@
 #include "defaultdriver.h"
 
+/**
+ * \class INDI::Focuser
+   \brief Class to provide general functionality of a focuser device.
+
+   Developers need to subclass INDI::Focuser to implement any driver for focusers within INDI.
+
+\author Gerry Rozema
+*/
 class INDI::Focuser : public INDI::DefaultDriver
 {
-
-    protected:
-    private:
-
     public:
         Focuser();
         virtual ~Focuser();
 
-        INumberVectorProperty FocusspeedNV;
-        INumber FocusspeedN[1];
-        ISwitchVectorProperty FocusmotionSV; //  A Switch in the client interface to park the scope
-        ISwitch FocusmotionS[2];
-        INumberVectorProperty FocustimerNV;
-        INumber FocustimerN[1];
-
+        enum FocusDirection { FOCUS_INWARD, FOCUS_OUTWARD };
 
         virtual bool initProperties();
         virtual void ISGetProperties (const char *dev);
-        bool updateProperties();
-
-
-        //  Ok, we do need our virtual functions from the base class for processing
-        //  client requests
-        //  We process Numbers in a focusser
+        virtual bool updateProperties();
         virtual bool ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n);
         virtual bool ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n);
+        virtual bool ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n);
+        virtual void ISSnoopDevice (XMLEle *root);
 
-        //  And here are the virtual functions we will have for easy overrides
-        virtual int Move(int, int, int);
+    protected:
+
+        /** \brief Move the focuser in a particular direction with a specific speed for a finite duration.
+            \param dir Direction of focuser, either FOCUS_INWARD or FOCUS_OUTWARD.
+            \param speed Speed of focuser if supported by the focuser.
+            \param duration The timeout in milliseconds before the focus motion halts.
+            \return True if succssfull, false otherwise.
+        */
+        virtual bool Move(FocusDirection dir, int speed, int duration);
+
+        INumberVectorProperty *FocusSpeedNP;
+        INumber FocusSpeedN[1];
+        ISwitchVectorProperty *FocusMotionSP; //  A Switch in the client interface to park the scope
+        ISwitch FocusMotionS[2];
+        INumberVectorProperty *FocusTimerNP;
+        INumber FocusTimerN[1];
 
 };