AnalogInInterface.hpp

// $Id: AnalogInInterface.hpp,v 1.10 2003/08/20 08:16:55 kgadeyne Exp $
/***************************************************************************
  tag: Peter Soetens  Thu Oct 10 16:16:56 CEST 2002  AnalogInInterface.hpp

                        AnalogInInterface.hpp -  description
                           -------------------
    begin                : Thu October 10 2002
    copyright            : (C) 2002 Peter Soetens
    email                : peter.soetens@mech.kuleuven.ac.be

 ***************************************************************************
 *   This library 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;                 *
 *   version 2 of the License.                                             *
 *                                                                         *
 *   As a special exception, you may use this file as part of a free       *
 *   software library without restriction.  Specifically, if other files   *
 *   instantiate templates or use macros or inline functions from this     *
 *   file, or you compile this file and link it with other files to        *
 *   produce an executable, this file does not by itself cause the         *
 *   resulting executable to be covered by the GNU General Public          *
 *   License.  This exception does not however invalidate any other        *
 *   reasons why the executable file might be covered by the GNU General   *
 *   Public License.                                                       *
 *                                                                         *
 *   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     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU General Public             *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 59 Temple Place,                                    *
 *   Suite 330, Boston, MA  02111-1307  USA                                *
 *                                                                         *
 ***************************************************************************/
/* Klaas Gadeyne, Mon August 11 2003
   - Added "channel" param to lowest(), highest(), resolution() calls (these
   are mostly configurable on a per channel basis.  If not, there's
   no problem
   - In comedi, this is also done for their "binary"-counterpoles.  I
   don't know if this is necessary

   Klaas Gadeyne, Wed August 20 2003
   - Added rangeSet() and arefSet() methods, that allready existed in
   the comedi implementations of these interfaces
*/

#ifndef ANALOGININTERFACE_HPP
#define ANALOGININTERFACE_HPP

#include "../NameServer.hpp"
#include "../NameServerRegistrator.hpp"
#include "../rtt-config.h"

namespace RTT
{
    class RTT_API AnalogInInterface
        : private NameServerRegistrator<AnalogInInterface*>
    {
    public:
        enum AnalogReference { Ground = 0, 
                               Common, 
                               Differential, 
                               Other 
        };

        AnalogInInterface( )
        {}

        AnalogInInterface( const std::string& name )
            : NameServerRegistrator<AnalogInInterface*>( nameserver, name, this )
        {}

        virtual ~AnalogInInterface()
        {}

        virtual void rangeSet(unsigned int chan,
                              unsigned int range) = 0;

        virtual void arefSet(unsigned int chan,
                             unsigned int aref) = 0;

        virtual int rawRead( unsigned int chan, int& value ) = 0;

        virtual int read( unsigned int chan, double& value ) = 0;

        virtual unsigned int rawRange() const = 0;

        virtual double lowest(unsigned int chan) const = 0;

        virtual double highest(unsigned int chan) const = 0;

        virtual double resolution(unsigned int chan) const = 0;

        virtual unsigned int nbOfChannels() const = 0;

        unsigned int binaryRange() const { return rawRange(); }

        int binaryLowest() const { return 0; }

        int binaryHighest() const { return rawRange(); }

        static NameServer<AnalogInInterface*> nameserver;

    private:

    };
};

#endif