RulbusDevice.h

/*
 * RulbusDevice.h - class RulbusDevice.
 *
 * 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: RulbusDevice.h 2 2004-10-12 11:54:15Z moene $
 */

#ifndef __RULBUSDEVICE_H
#define __RULBUSDEVICE_H

#ifndef __COMMON_H
   #include "Common.h"
#endif

#include <iosfwd>               // for std::ostream

namespace Rulbus
{
   DECLARE_CLASS( RulbusDevice );
   DECLARE_CLASS( TheRulbusInterface );

   /* - <em>provide %Rulbus Interface creation</em> -- the class provides
    * methods createInterface() and destroyInterface() to create and destroy
    * the proper %Rulbus Interface; to this end it uses the
    * RulbusInterfaceFactory Singleton(127)
    */

   class RulbusDevice
   {
   public:                                         // P U B L I C

      RulbusDevice( Name aName, Addr aAddr, Addr aWidth, Rack aRack );
//      RulbusDevice( Name aName = "(empty)", Addr aAddr = 0xFF, Addr aWidth = 0, Rack aRack = 0 );

      virtual ~RulbusDevice();


      Name          name () const;
      Rack          rack () const;
      Addr          addr () const;
      Addr          width() const;


      bool          eqRack( RulbusDeviceCref rhs ) const;
      bool          eqAddr( RulbusDeviceCref rhs ) const;


      void          setRack( Rack aRack );
      void          setAddr( Addr aAddr );


      virtual int   printOn( std::ostream& stream ) const;


      int           getByte( int offset           ) const;
      int           putByte( int offset, int byte ) const;


/*
      static  void  createInterface();
      static  void  destroyInterface();
      static  int   printInterface();
*/

   protected:                                           // P R O T E C T E D

      RulbusDevice( );                                  
      RulbusDevice( RulbusDeviceCref );                 
      RulbusDeviceRef operator= ( RulbusDeviceCref );   


      void   checkValidAddress( int offset = 0       ) const;
      void   checkBusViolation( int offset, int byte ) const;


      static TheRulbusInterfaceRef theRulbus();


   public:
      static const int ANY_RACK = 0xF;          
      static const int DEF_RACK = ANY_RACK;     


   private:                                     // P R I V A T E
      Name   theName;                           
      Rack   theRack;                           
      Addr   theAddr;                           
      Addr   theWidth;                          

//      static RulbusInterfaceCptr theInterface;  ///< the %Rulbus Interface implementation
   };

   inline Name RulbusDevice::name() const
   {
      return theName;
   }

   inline Rack RulbusDevice::rack() const
   {
      return theRack;
   }

   inline Addr RulbusDevice::addr() const
   {
      return theAddr;
   }

   inline Addr RulbusDevice::width() const
   {
      return theWidth;
   }

   inline bool RulbusDevice::eqRack( RulbusDeviceCref rhs ) const
   {
      return rack() == ANY_RACK || rhs.rack() == ANY_RACK || rack() == rhs.rack();
   }

   inline bool RulbusDevice::eqAddr( RulbusDeviceCref rhs ) const
   {
      return         eqRack( rhs )
      && (         addr() == rhs.addr()
          || (     addr() <  rhs.addr() &&     addr() +     width() > rhs.addr() )
          || ( rhs.addr() <      addr() && rhs.addr() + rhs.width() >     addr() ) );
   }

   inline RulbusDeviceRef to_rb( RulbusDevicePtr p )
   {
      return PROXY_CAST<RulbusDeviceRef>( *p );
   }

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

}       // namespace Rulbus

/*------------------------------------------------------------------------
 * convenience functions
 *------------------------------------------------------------------------
 */

inline std::ostream& operator<< ( std::ostream& stream, const Rulbus::RulbusDevice& aDevice )
{
   aDevice.printOn( stream );
   return stream;
}

inline std::ostream& operator<< ( std::ostream& stream, Rulbus::RulbusDeviceCptr aDevicePtr )
{
   aDevicePtr->printOn( stream );
   return stream;
}

#endif  // __RULBUSDEVICE_H

/*
 * end of file
 */

---