ComediDevice.hpp

// Copyright (C) 2002 Peter Soetens
// Copyright (C) 2003,2007 Klaas Gadeyne
/***************************************************************************
 *   This library is free software; you can redistribute it and/or         *
 *   modify it under the terms of the GNU Lesser General Public            *
 *   License as published by the Free Software Foundation; either          *
 *   version 2.1 of the License, or (at your option) any later version.    *
 *                                                                         *
 *   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 Lesser 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, August 14, 2003
   Major rewrite of original file by Peter Soetens
*/

#ifndef OCL_COMEDIDEVICE_HPP
#define OCL_COMEDIDEVICE_HPP

#include <boost/shared_ptr.hpp>

namespace OCL
{
  class ComediDevice
  {
  protected:
      class DeviceInfo;
      boost::shared_ptr<DeviceInfo> d;
  public:
    typedef unsigned int Data;

    ComediDevice( unsigned int minor );
    virtual ~ComediDevice( );

    Data getMaxData(unsigned int subd);

    int read( unsigned int subd, unsigned int chanNr,
          unsigned int range, unsigned int aref, Data& value );

    /*
      Writes a single sample on the channel that is specified by the
      subdevice subdevice, and the channel channel.  If appropriate,
      the device is configured to use range specification range and
      analog reference type aref.  Analog reference types that are not
      supported by the device are silently ignored.  The function
      writes the data value specified by the parameter data to the
      specified channel.

      @return 0 on succes (not with all drivers, unfortunately, -1 on error
      @param subd : the subdevice to write on
      @param chanNr : the channel of subdevice subdevice to write on
      @param value : the data sample to write
      @param range : number between 0 and get_num_ranges(), @see get_num_ranges()
      @param aref : possible options (see comedi doc) AREF_GROUND,
      AREF_COMMON, AREF_DIFF, AREF_OTHER
    */
    int write( unsigned int subd, unsigned int chanNr,
           unsigned int range, unsigned int aref,
           const ComediDevice::Data& value);

    int getSubDeviceType(unsigned int subd);

    DeviceInfo* getDevice();

  };


};

#endif

---