Lattice.h

Go to the documentation of this file.

// $Id: Lattice.h,v 1.2 2000/05/10 10:07:04 west Exp $

#if !defined(LATTICE_H)
#define LATTICE_H


// Lattice                                                            //
//                                                                    //
// Package: Lat (Lattice Navigation Model).                           //
//                                                                    //
// Minos version of Lattice.  Unlike CLEO, Minos Lattice inherits 
// privatetly from LatticeBase, instead it owns one and exposes services
// as required.  There is a shift in perspective: as a Minos lattice
// is symmetric (left and right IDs are same type) the view is more
// in terms of near side and far side. Also as a lattice is primarily
// used as a source of vectors that are built into iterators the user
// passes in a vector to be filled rather than having the lattice 
// return a const iterator.
//
// N. West  03/2000                                                   //


#include "Lattice/LatticeBase.h"
#include "Lattice/LatticeDef.h"


class Lattice : private LatticeBase
{

public:

//    N.B. kBoth = kLeft + kRight so can do e.g. far = kBoth - near;

enum ESide  { kLeft = 1,  kRight = 2, kBoth = 3 };

typedef LatticeDef::ID               ID;
typedef LatticeDef::VectorID         VectorID;
typedef LatticeBase::LatticeTopology Topology;
typedef LatticeBase::RightNode       RightNode;
typedef LatticeBase::LeftNode        LeftNode;
typedef LatticeBase::Link            Link;

// Constructors and destructors
                           Lattice(const Text_t* lName,
                                   const Text_t* rName,
                                   Topology i =  LatticeBase::Default,
                                   Topology j =  LatticeBase::Default,
                                   Topology k =  LatticeBase::Default,
                                   Topology l =  LatticeBase::Default);
  virtual                 ~Lattice();

// State testing member functions

  virtual void GetAllIDs(  ESide side, VectorID& ids) const;
  virtual void GetFarIDs(  ESide side, ID startFrom, VectorID& ids) const;
  virtual void GetNearIDs( ESide side, ID startFrom, VectorID& ids) const;

 
// State changing member functions
  virtual Link* ConnectLR(ID leftID, ID rightID);
  virtual Link* ConnectLR(ID leftID, Link* link, ID rightID);

  virtual Link* Connect(ESide side, ID nearID, ID farID);
  virtual Link* Connect(ESide side, ID nearID, Link* link, ID farID);

protected:


private:
// Data members

  string       fLeftName;
  string       fRightName;
};


#endif /* LATTICE_H */

---