LatticeNode.h

Go to the documentation of this file.

#if !defined(LATTICE_LATTICENODE_H)
#define LATTICE_LATTICENODE_H
// -*- C++ -*-
//
// Package:     Lattice
// Module:      LatticeNode
// 
// Description:  Declare lattice node class.
//
// Usage:  Included by LatticeBase.h.
//   The actual implementation is a pair of classes, LatticeLeftNode and
//   LatticeRightNode.  Perhaps this dichotomy can be eliminated.
//   The constructors are private, so only LatticeBase can make new nodes.
//
// See the web documentation:
//    http://www.lns.cornell.edu/restricted/CLEO/CLEO3/soft/
//
// Author:      Jon Thaler
// Created:     Sat Apr 4 07:03:03 EST 1998
// $Id: LatticeNode.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"

//

//
//

//==============================================================
//------------------+
// LatticeLeftNode: |
//------------------+ 
class LatticeLeftNode
{
 public:
  //-----------------------------------------------------+
  // friend classses and functions                       |
  //  Lattice base class has control of LatticeLeftNode. |
  //-----------------------------------------------------+
  friend class LatticeBase;

  //----------+
  // typedefs |
  //----------+
  typedef LatticeBase      Lattice;
  typedef LatticeLink      Link;
  typedef LatticeLeftNode  LeftNode;
  typedef LatticeRightNode RightNode;

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

  typedef LatticeDef::VectorLeftID         VectorLeftID;
  typedef LatticeDef::VectorRightID        VectorRightID;
  typedef LatticeDef::Links                Links;

  typedef VectorLeftID ::const_iterator LeftItr;
  typedef VectorRightID::const_iterator RightItr;
  typedef Links        ::const_iterator LinkItr;

  //----------+
  // Methods. |
  //----------+
  const Links&      links          ()         const;
  Bool_t         isLinkedTo     (RightID)  const;
  Bool_t         sharesLinksWith(LeftID)   const;
  LeftID            identifier     ()         const;
  void              show           (ostream&) const;

 protected:
 private:
  //---------------------------+
  // Constructors & destructor |
  //---------------------------+
  LatticeLeftNode(const LatticeDef::StoreType&);
  LatticeLeftNode(LeftID);
  ~LatticeLeftNode();

  //------------------------------------+
  // Disabled constructors & assignment |
  // No definitions in the .cc file.    |
  //------------------------------------+
  LatticeLeftNode();
  LatticeLeftNode(const LatticeLeftNode&);
  const LatticeLeftNode& operator = (const LatticeLeftNode&);

  //-------------+
  // Member data |
  //-------------+
  Links&         m_Links;
  VectorLeftID&  m_VLeftID;
  VectorRightID& m_VRightID;
  const LeftID   m_ID;
};

//==============================================================
//-------------------+
// LatticeRightNode: |
//-------------------+ 
class LatticeRightNode
{public:

  //-------------------------------------------------+
  // friend classses and functions                   |
  //  Lattice class has control of LatticeRightNode. |
  //-------------------------------------------------+
  friend class LatticeBase;

  //----------+
  // typedefs |
  //----------+
  typedef LatticeBase      Lattice;
  typedef LatticeLink      Link;
  typedef LatticeLeftNode  LeftNode;
  typedef LatticeRightNode RightNode;
      
  typedef LatticeDef::LeftID                LeftID;
  typedef LatticeDef::RightID               RightID;

  typedef LatticeDef::VectorLeftID          VectorLeftID;
  typedef LatticeDef::VectorRightID         VectorRightID;
  typedef LatticeDef::Links                 Links;

  typedef VectorLeftID ::const_iterator  LeftItr;
  typedef VectorRightID::const_iterator  RightItr;
  typedef Links        ::const_iterator  LinkItr;

  //----------+
  // Methods. |
  //----------+
  const Links&      links          ()         const;
  Bool_t         isLinkedTo     (LeftID)   const;
  Bool_t         sharesLinksWith(RightID)  const;
  RightID           identifier     ()         const;
  void              show           (ostream&) const;

 protected:
 private:
  //-----------------------------+
  // Constructors and destructor |
  //-----------------------------+
  LatticeRightNode(const LatticeDef::StoreType&);
  LatticeRightNode(RightID);
  ~LatticeRightNode();

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

  //--------------+
  // Member data: |
  //--------------+
  Links&         m_Links;
  VectorRightID& m_VRightID;
  VectorLeftID&  m_VLeftID;
  const RightID  m_ID;
};

#endif /* LATTICE_LATTICENODE_H */

---