SpecsInterface.h

Go to the documentation of this file.

//$Id: SpecsInterface.h,v 1.9 2006/10/24 13:28:40 fmachefe Exp $
//-----------------------------------------------------------------------------
//
//  Package    : SpecsInterface
//
//  Description:
//
//  Author(s)  : F. Machefert -
//  Date       : 18 January 2004
//
//-----------------------------------------------------------------------------

#ifndef SPECSINTERFACE_H
#define SPECSINTERFACE_H 1

#include <algorithm>
#include <string>
#include <vector>
#include <list>

#include "Interface.h"

// SpecsLib include files
#ifndef _NODEVICE_
#include "SpecsUser.h"
#else 
typedef unsigned char U8;
typedef unsigned short U16;
typedef unsigned long U32;
#endif

class SpecsSlave;
class SpecsMaster;

namespace CATApp {
  enum Quality { BAD , GOOD } ;
  enum Mode { BUS , I2C } ;
  typedef std::pair< U32 , Quality > IntWQuality ;
}

class SpecsInterface : public Interface {
public:
  SpecsInterface( ); 
  virtual ~SpecsInterface( ){} //< Destructor


  virtual void help() { info("SpecsInterface "+name()+". No help.","SpecsInterface::help"); };

  virtual StatusCode init() {
    info("SpecsInterface "+name()+" initialization.","SpecsInterface::init");
    return StatusCode::SUCCESS;
  };

  virtual void reset() { info("SpecsInterface "+name()+" reset.","SpecsInterface::reset");};

  virtual void update () {info("SpecsInterface "+name()+". Nothing to do.","SpecsInterface::update");};
  

  // Element Address
  void setAddress(unsigned char); //< set the element address

  unsigned char address(); //< return the element address

  void setOutputSelect(unsigned char); //< i2c Output selection if applicable

  unsigned char outputSelect(); //< return i2c output selection id applicable
  
  virtual SpecsSlave* specsSlave();

  virtual SpecsMaster* specsMaster();

#ifndef _NODEVICE_  

  virtual SPECSSLAVE* specsSlaveDevice();

  virtual SPECSMASTER* specsMasterDevice();
#endif

  virtual StatusCode read(IOdata* io) { return StatusCode::SUCCESS; };
  virtual StatusCode write(IOdata* io) { return StatusCode::SUCCESS; };
  
  bool specsWriteI2c( unsigned char address ,
                      unsigned char nData ,
                      U8* data );

  bool specsWriteI2c( unsigned char address ,
                      std::vector<U8> data );

  bool specsReadI2c( unsigned char address ,
                     unsigned char nOctects ,
                     U8* i2cWords );
  
  bool specsReadI2c( unsigned char address ,
                      std::vector<unsigned char>& specsWords );

  bool specsWriteI2c( unsigned char address ,
                      unsigned char subAddress ,
                      unsigned char nData ,
                      U8* data );

  bool specsWriteI2c( unsigned char address ,
                      unsigned char outputSel,
                      unsigned char subAddress ,
                      unsigned char nData ,
                      U8* data );

  bool specsReadI2c( unsigned char address , 
                     unsigned char subAddress ,
                     unsigned char nOctets ,
                     U8* i2cWords );

  bool specsReadI2c( unsigned char address , 
                     unsigned char outputSel ,
                     unsigned char subAddress ,
                     unsigned char nOctets ,
                     U8* i2cWords );

  bool specsWriteParallel( unsigned char address, 
                           unsigned short data);

  bool specsReadParallel( unsigned char address,
                          U16& data);

  bool specsWriteRegister( unsigned char ,
                           unsigned short );

  bool specsReadRegister( unsigned char ,
                          U16 & );


private:
  int           m_slot;        //< Element Slot if applicable 
protected:
  unsigned char m_address;     //< Element electronics address
  unsigned char m_outputSelect;//< Element output Select for i2c protocol

};

#endif