rb9005_amplifier.h

/*
 * rb9005_amplifier.h - instrumentation amplfier (RB9005).
 *
 * This file is part of the Rulbus Device Class Library (RDCL).
 *
 * Copyright (C) 2003-2004, Leiden University.
 *
 * 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; either version 2 of the License, or
 * (at your option) any later version.
 *
 * The 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with mngdriver; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * $Id: rb9005_amplifier.h 2 2004-10-12 11:54:15Z moene $
 */

#ifndef __RB9005_AMPLIFIER_H
#define __RB9005_AMPLIFIER_H

#ifndef __RULBUSDEVICE_H
#include "RulbusDevice.h"       // for class RulbusDevice
#endif

namespace Rulbus
{
   DECLARE_CLASS( RB9005_amplifier );  //

   /* *
    * \example name.cpp
    * This is an example that shows ... .
    */

   class RB9005_amplifier : public RulbusDevice
   {
   public:                              // public methods
      typedef Int  Value;               


      RB9005_amplifier( NameCref name, Addr addr = DEF_ADDR, Rack rack = DEF_RACK );

      ~RB9005_amplifier();


      int  channel              ( ) const;
      int  gain                 ( int aChannel ) const;
      Freq lowPassFrequency     ( int aChannel ) const;

      bool isChannelSequenceMode( ) const;
      bool isClockSequenceMode  ( ) const;


      void setChannel           ( int aChannel );
      void setGain              ( int aChannel, int aGain );
      void setLowPassFrequency  ( int aChannel, Freq aFrequency );

      void enableChannelSequenceMode( bool enable = true );
      void enableClockSequenceMode  ( bool enable = true );


   protected:                                   // protected methods

      RB9005_amplifier();                               
      RB9005_amplifier( RB9005_amplifierCref rhs );               
      RB9005_amplifierRef operator= ( RB9005_amplifierCref rhs ); 


      void checkChannel( int aChannel ) const;

      int  gain12      ( int aChannel ) const;
      int  gain34      ( int aChannel ) const;

      Freq lpf12       ( int aChannel ) const;
      Freq lpf34       ( int aChannel ) const;

      void setGain12   ( int aChannel, int aGain );
      void setGain34   ( int aChannel, int aGain );

      void setLpf12    ( int aChannel, Freq aFrequency );
      void setLpf34    ( int aChannel, Freq aFrequency );


   public:                                      // public data

      static const Addr  DEF_ADDR = 0xB3;       


      static const Value LIM_MINCHN = 1;        
      static const Value LIM_MAXCHN = 4;        


   private:                                     // private data

      Byte theGain12Register;                   
      Byte theGain34Register;                   
      Byte theFreq1Register;                    
      Byte theFreq2Register;                    
      Byte theMuxRegister;                      


      static const int OFF_GAIN12 = 0;          
      static const int OFF_MUX    = 1;          
      static const int OFF_GAIN34 = 2;          
      static const int OFF_FREQ1  = 3;          
      static const int OFF_FREQ2  = 4;          
      static const int ADR_WIDTH  = OFF_FREQ2 + 1; 



      static const int MSK_GAIN1  = 0x0F;       
      static const int MSK_GAIN2  = 0xF0;       

      static const int SHL_GAIN1  = 0;          
      static const int SHL_GAIN2  = 4;          


      static const int MSK_GAIN3  = 0x03;       
      static const int MSK_GAIN4  = 0x0C;       

      static const int SHL_GAIN3  = 0;          
      static const int SHL_GAIN4  = 2;          


      static const int MSK_LPF12  = 0x0F;       
      static const int SHL_LPF12  = 0;          


      static const int MSK_CHN1   = 0x07;       
      static const int MSK_CHN2   = 0x38;       
      static const int MSK_CHNSEQ = 0x40;       
      static const int MSK_CLKSEQ = 0x80;       

      static const int SHL_CHN1   = 0;          
      static const int SHL_CHN2   = 3;          



      struct RegInfo                            
      {
         int mask; int shift;
      };

      static const RegInfo GainInfoTable[];     

      static const int     gain12Table[];       
      static const int     gain34Table[];       
      static const Freq    freq12Table[];       

   };


   inline RB9005_amplifierRef to_rb9005( RulbusDevicePtr p )
   {
      return PROXY_CAST<RB9005_amplifierRef>( *p );
   }

   inline RB9005_amplifierPtr to_rb9005_ptr( RulbusDevicePtr p )
   {
      return PROXY_CAST<RB9005_amplifierPtr>( p );
   }


} // namespace Rulbus

#endif  // __RB9005_AMPLIFIER_H

/*
 * end of file
 */

---