---

GPIBController.h

Go to the documentation of this file.

/*
 * Time-stamp: <00/08/07 18:53:36 pagey>
 *
 * $Id: GPIBController.h,v 0.13 2000/08/08 02:38:50 pagey Exp $
 *
 */
#ifndef GPIBController_h
#define GPIBController_h

#include <list>
#include <string>
#include <fstream>
#include "GPIBEquipment.h"
#include "LibGPIB.h"

extern "C++" {
  namespace LibGPIB {
    class GPIBController : public iostream {
    public: 
      typedef GPIBEquipment *                    GPIBEquipmentPtr ;
      typedef list<GPIBEquipmentPtr>             GPIBEquipmentList ;
      typedef GPIBEquipmentList::iterator        GPIBEquipmentListIterator ;
      typedef GPIBEquipmentList::const_iterator  GPIBEquipmentListConstIterator ;

      /* ----------------------------------------------------------------------
       * Public Static Members
       * ----------------------------------------------------------------------
       */
      static const char CR = 13 ;

      static const char LF = 10 ;

      enum EOSModeVal {
        EOS_TERM_READ = (1<<2), 
        EOS_WRITE_EOI = (1<<3), 
        EOS_EIGHT_BIT = (1<<4)  
      } ;



      GPIBController() ; 

      virtual ~GPIBController() = 0 ;


      void Open() = 0 ;

      void Close() = 0 ;

      virtual void BecomeActiveController(bool synchronously=true) = 0 ;

      virtual void ClearDevice(GPIBEquipment &device) = 0 ;

      virtual void SendCommand(GPIBEquipment &device, const string command) = 0 ;

      virtual const string ReadData(GPIBEquipment &device, const int read_bytes) = 0 ;

      virtual void SetLocal(GPIBEquipment &device) = 0 ;

      /*
       * Send the a command to the device asynchronously. 
       *
       */
      /* virtual void SendCommandAsync(const GPIBEquipment &device, const string command) = 0.0 ;
       */ 

      virtual void SetEOSModeAndChar(const EOSModeVal mode, const char eos) = 0 ; 

      const EOSModeVal SetEOSMode(const EOSModeVal mode) ;

      const EOSModeVal EOSMode() const ;

      const char SetEOSChar(const char eos) ;

      const char EOSChar() const ;

      void ConnectDevice(GPIBEquipment& device) ; 

      void DisconnectDevice(GPIBEquipment& device) ;
    
      void DisconnectAllDevices() ; 

      /*
       * Scan the GPIB bus and extracts a list of devices
       * which are connected to the bus. The routine checks 
       * for listening devices at GPIB addresses from mAddressMin 
       * to mAddressMax (all inclusive). 
       *
       */
      /* virtual void DetectDevices() = 0.0 ; */




      /* ----------------------------------------------------------------------
       * Friends
       * ----------------------------------------------------------------------
       */
      friend GPIBEquipmentBuffer ;
    protected:
      /* ----------------------------------------------------------------------
       * Protected Data Members
       * ----------------------------------------------------------------------
       */
      /* ----------------------------------------------------------------------
       * Protected Methods
       * ----------------------------------------------------------------------
       */
      virtual ostream& SendCharPrefix( const int primary_address, 
                                       const int secondary_address=0 ) = 0 ;

      virtual ostream& SendCharPostfix( const int primary_address, 
                                        const int secondary_address=0 ) = 0 ;

      virtual ostream& ReadCharPrefix( const int primary_address, 
                                       const int secondary_address=0 ) = 0 ;

      virtual ostream& ReadCharPostfix( const int primary_address, 
                                        const int secondary_address=0) = 0 ;

    private:
      /* ----------------------------------------------------------------------
       * Private Data Members
       * ----------------------------------------------------------------------
       */
      GPIBEquipmentList mDeviceList ;
     
      int mIOTimeout ; 

      int mEOIMode ;
    
      EOSModeVal mEOSMode ; 

      char mEOSChar ;
      /* ----------------------------------------------------------------------
       * Private Methods
       * ----------------------------------------------------------------------
       */
    } ;
    
    inline 
    GPIBController::GPIBController() :
      iostream(0) { 
      mEOSMode = EOS_TERM_READ ; 
      mEOSChar = '\n' ;
      mEOIMode = 0 ;
      mIOTimeout = 0 ;
      
    } 

    inline
    GPIBController::~GPIBController() {
      DisconnectAllDevices() ; 
    }

    inline 
    const GPIBController::EOSModeVal 
    GPIBController::SetEOSMode(const EOSModeVal mode) {
      SetEOSModeAndChar(mode, mEOSChar) ; 
      return mEOSMode ; 
    } 

    inline
    const GPIBController::EOSModeVal 
    GPIBController::EOSMode() const {
      return mEOSMode ;
    }

    inline
    const char GPIBController::SetEOSChar(const char eos) { 
      SetEOSModeAndChar(mEOSMode, eos) ; 
      return mEOSChar ; 
    }

    inline
    const char
    GPIBController::EOSChar() const {
      return mEOSChar ;
    }

  } // namespace LibGPIB
} // extern "C++" 

#endif

---