LatticeLink.h

Go to the documentation of this file.

#if !defined(LATTICE_LATTICELINK_H)
#define LATTICE_LATTICELINK_H
// -*- C++ -*-
//
// Package:     Lattice
// Module:      LatticeLink
// 
// Description: Declare lattice link class.
//
// Usage:       Included by LatticeBase.h.  Most interface is there.
//
// Author:      Jon Thaler
// Created:     Sat Apr  4 07:03:03 EST 1998
// $Id: LatticeLink.h,v 1.2 2000/05/10 10:07:04 west Exp $
//
//  Minos Revision History
//  
//  This file has been converted automatically from the corresponding CLEO
//  Lattice code by Nick West on: 14/03/2000 08:38:07
//  
//  It is being used to explore the possibility that a modified Lattice
//  can be used in MINOS.  The main changes are:-
//  
//      1)  The removal Lattice templates classes:-
//  
//           a)  LinkData is dummy
//           b)  Left and Right ID types are void*
//  
//      2)  Conversion of CLEO types and includes to MINOS equivalents
//          e.g.:-
//  
//           a)  DABoolean -> Bool_t
//           b)  report    -> MSG
#include "Lattice/LatticeDef.h"

//

//
//

//===================================================================
//-------------------------------------------------------+
// Define the default (empty) Lattice link data class.   |
//-------------------------------------------------------+
class DefaultLinkData
{};

//=================================================================== 
class LatticeLink
{
 public:

  //------------------------------------------------+
  // Friend classes and functions                   |
  //  LatticeBase class has control of LatticeLink. |
  //------------------------------------------------+
  friend class LatticeBase;
      
  //----------+
  // typedefs |
  //----------+
  typedef LatticeBase      Lattice;
  typedef LatticeLeftNode  LeftNode;
  typedef LatticeRightNode RightNode;

  typedef LatticeDef::LeftID        LeftID;
  typedef LatticeDef::RightID       RightID;

  typedef LatticeDef::VectorLeftID  VectorLeftID;
  typedef LatticeDef::VectorRightID VectorRightID;
  typedef LatticeDef::LinkData               LinkData;
      
  //-------------+
  // Data access |
  //-------------+
  // Retrieve the link data.
  LinkData&       linkData();
  const LinkData& linkData() const;

  // Retrieve the vector of data on the left or right side of the link.
  const VectorLeftID&  vLeftID () const;
  const VectorRightID& vRightID() const;

  // Retrieve the one datum on the left or right side of the link.
  const LeftID*  leftID () const;
  const RightID* rightID() const;

  // Display the link.
  void  show(ostream&) const;

 protected:
 private:
  //-----------------------------+
  // Constructors and destructor |
  // Only Lattice has access.    |
  //-----------------------------+
  LatticeLink(LeftNode*, RightNode*);
  LatticeLink(LeftNode*, RightNode*, const LinkData&);
  ~LatticeLink();

  //--------------------------------------+
  // Disabled constructors and assignment |
  //--------------------------------------+
  LatticeLink();
  LatticeLink(const LatticeLink&);
  const LatticeLink& operator = (const LatticeLink&);

  //--------------------------------------------------------+
  // Member data:                                           |
  //  m_LinkData  The user specified link data object.      |
  //  m_VLeftID   Vector of left IDs attached to this link. |
  //  m_VRightID     "   "  right "     "     "   "    "    |
  //--------------------------------------------------------+
  LinkData&      m_LinkData;
  VectorLeftID&  m_VLeftID;
  VectorRightID& m_VRightID;
};

#endif /* LATTICE_LATTICELINK_H */

---