LatticeBuilder.h

Go to the documentation of this file.

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

#if !defined(LATTICEBUILDER_H)
#define LATTICEBUILDER_H


// LatticeBuilder                                                            //
//                                                                    //
// Package: Lat (Lattice Navigation Model).                           //
//                                                                    //
// 
// 
// LatticeBuilder is a tool to simplify Lattice building in those
// cases where the relationship can be expressed in terms of a key
// convertible to Long_t.  The build process is as follows:-
// 
// 1)  Create an empty Lattice.
// 
// 2)  Dock it to the builder using DockLattice();
// 
// 3)  Loop over the primaries i.e. that side of the Lattice
//     whose object's map to keys and call AddPrimary().
// 
// 4)  Loop over secondaries, determine the key of the associated
//     primary and call AddSecondary.
// 
// Note:-
// ====
// 
// 1)  The LatticeBuilder never clears the Lattice, the owner must
//     do that if required.
// 
// 2)  All AddPrimary calls must come before any secondary call.
// 
// 3)  Only those primaries that are actually connected to one
//     or more secondary are recorded in the lattice.
// 
// 4)  The same LatticeBuilder can be used to build any number
//     of Lattices; docking a new Lattice reinitialises the builder
// 
// 
//
// N. West  03/2000                                                   //

#include <map>
#include "Rtypes.h"
#include "Lattice/Lattice.h"

class Lattice;

class LatticeBuilder
{

public:

typedef    Long_t            Key;
typedef    Lattice::ESide    ESide;
typedef    Lattice::ID       ID;

// Constructors and destructors
                           LatticeBuilder();
                           LatticeBuilder( Lattice* lattice,
                                           ESide primarySide);
  virtual                 ~LatticeBuilder();

// State testing member functions

 
// State changing member functions

Bool_t AddPrimary(   Long_t key, ID primaryID);
Bool_t AddSecondary( Long_t key, ID secondaryID);
 void  DockLattice( Lattice* lattice, ESide primarySide);

protected:


private:

enum EState { kFloating, kHasLattice, kHasPrimary, kHasSecondary };

// Data members

  Lattice*                 fLattice;
  map<const Key, ID>       fKeyMap;
  ESide                    fPrimarySide;
  EState                   fState;
};


#endif /* LATTICEBUILDER_H */

---