rb8513_timebase.h

/*
 * rb8513_timebase.h - programmable timebase (RB8513).
 *
 * 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: rb8513_timebase.h 2 2004-10-12 11:54:15Z moene $
 */

#ifndef __RB8513_TIMEBASE_H
#define __RB8513_TIMEBASE_H

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

namespace Rulbus
{
   DECLARE_CLASS( RB8513_timebase );  //

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

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


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

      ~RB8513_timebase();


      Time  intervalTime() const;

      Value clockRateMultiplier() const;
      Value clockRateSelector  () const;



      void stop();

      void setIntervalTime        ( Time  aTime      );

      void setClockRateMultiplier ( Value aValue     );
      void setClockRateSelector   ( Value aValue     );


   protected:                                   // protected methods

      RB8513_timebase();                                        
      RB8513_timebase( RB8513_timebaseCref rhs );               
      RB8513_timebaseRef operator= ( RB8513_timebaseCref rhs ); 


   public:                                      // public data

      static const Addr DEF_ADDR   = 0xB0;      

      static const int  DEF_MUL    = 1;         
      static const int  DEF_SEL    = 4;         


      static const int  LIM_MULMIN =  0;        
      static const int  LIM_MULMAX = 99;        

      static const int  LIM_SELMIN =  0;        
      static const int  LIM_SELMAX =  6;        
      static const int  LIM_SELMAXFIXED = 3;    


   private:                                     // private data

      Value theMutiplyReg;                      
      Value theSelectorReg;                     


      static const int OFF_MUL     = 0;         
      static const int OFF_SEL     = 1;         
      static const int ADR_WIDTH   = OFF_SEL + 1; 


      static const int MSK_SELSTP  = 0x10;      


      static const Time  timeList[];            
      static const Value selectorList[];        

   };


   inline RB8513_timebase::Value RB8513_timebase::clockRateMultiplier() const
   {
      return theMutiplyReg;
   }

   inline RB8513_timebase::Value RB8513_timebase::clockRateSelector() const
   {
      return theSelectorReg;
   }

   inline RB8513_timebaseRef to_rb8513( RulbusDevicePtr p )
   {
      return PROXY_CAST<RB8513_timebaseRef>( *p );
   }

   inline RB8513_timebasePtr to_rb8513_ptr( RulbusDevicePtr p )
   {
      return PROXY_CAST<RB8513_timebasePtr>( p );
   }

} // namespace Rulbus

#endif  // __RB8513_TIMEBASE_H

/*
 * end of file
 */

---