LatticeBuilder Class Reference

#include <LatticeBuilder.h>

List of all members.

Public Types
typedef Long_t	Key
typedef Lattice::ESide	ESide
typedef Lattice::ID	ID
Public Member Functions
	LatticeBuilder ()
	LatticeBuilder (Lattice *lattice, ESide primarySide)
virtual	~LatticeBuilder ()
Bool_t	AddPrimary (Long_t key, ID primaryID)
Bool_t	AddSecondary (Long_t key, ID secondaryID)
void	DockLattice (Lattice *lattice, ESide primarySide)
Private Types
	kFloating
	kHasLattice
	kHasPrimary
	kHasSecondary
enum	EState { kFloating, kHasLattice, kHasPrimary, kHasSecondary }
Private Attributes
Lattice *	fLattice
map< const Key, ID >	fKeyMap
ESide	fPrimarySide
EState	fState

---

Detailed Description

Definition at line 53 of file LatticeBuilder.h.

---

Member Typedef Documentation

typedef Lattice::ESide LatticeBuilder::ESide

Definition at line 59 of file LatticeBuilder.h.

typedef Lattice::ID LatticeBuilder::ID

Definition at line 60 of file LatticeBuilder.h.

typedef Long_t LatticeBuilder::Key

Definition at line 58 of file LatticeBuilder.h.

---

Member Enumeration Documentation

enum LatticeBuilder::EState [private]

Enumerator:

kFloating
kHasLattice
kHasPrimary
kHasSecondary

Definition at line 82 of file LatticeBuilder.h.

{ kFloating, kHasLattice, kHasPrimary, kHasSecondary };

---

Constructor & Destructor Documentation

LatticeBuilder::LatticeBuilder

(

)

Definition at line 140 of file LatticeBuilder.cxx.

References DockLattice(), and Lattice::kLeft.

                                {

//  Purpose:   Default Constructor
//  Arguments: None
//            
//  Return:    n/a

//  Contact:   N. West


   DockLattice( 0, Lattice::kLeft ); 
}

LatticeBuilder::LatticeBuilder	(	Lattice *	lattice,
		ESide	primarySide
	)

Definition at line 155 of file LatticeBuilder.cxx.

References DockLattice().

                                                   {

//  Purpose:   Constructor
//  Arguments:
//     lattice      in  The lattice to be docked ready for filling
//     primarySide  in  The side of lattice holding primaries.
//                   
//            
//  Return:    n/a

//  Contact:   N. West


   DockLattice( lattice, primarySide ); 
}

LatticeBuilder::~LatticeBuilder

(

)

[virtual]

Definition at line 174 of file LatticeBuilder.cxx.

{}

---

Member Function Documentation

Bool_t LatticeBuilder::AddPrimary	(	Long_t	key,
		ID	primaryID
	)

Definition at line 31 of file LatticeBuilder.cxx.

References fKeyMap, fState, kHasLattice, kHasPrimary, Msg::kWarning, and MSG.

Referenced by NavGenLattice::Rebuild(), LatValidate::Test_1(), and LatValidate::Test_2().

                                                             {

//  Purpose:   Add primary to lattice
//  Arguments: 
//      Key          in   Key associated with primary
//      primaryID    in   ID of  primary
//            
//  Return:    kTRUE if request accepted.

//  Contact:   N. West


// Specification:-
// =============

// o  Record the keys and IDs of all primaries ready for pass over 
//    secondaries.


//  Confirm that we can record a primary.

  if ( fState != kHasLattice && fState != kHasPrimary ) {
    MSG("Lat",Msg::kWarning) << "Lattice not ready for primaries " 
                             <<endl;
    return kFALSE;
  }


//  Record key in look-up table.
  fKeyMap[key] = primaryID;
  fState       = kHasPrimary;
  return kTRUE;

}

Bool_t LatticeBuilder::AddSecondary	(	Long_t	key,
		ID	secondaryID
	)

Definition at line 68 of file LatticeBuilder.cxx.

References Lattice::Connect(), fKeyMap, fLattice, fPrimarySide, fState, kHasPrimary, kHasSecondary, Msg::kWarning, and MSG.

Referenced by NavGenLattice::Rebuild(), LatValidate::Test_1(), and LatValidate::Test_2().

                                                               {

//  Purpose:   
//      Key          in   Key associated with secondary
//      primaryID    in   ID of  secondary
//            
//  Return:    kTRUE if request accepted.
//            
//  Return:    

//  Contact:   N. West

// Specification:-
// =============

// o  Look up the key and record the (primary,secondary) pair in 
  //  the lattice.

//  Confirm that we can build a primary secondary pair.

  if ( fState != kHasSecondary && fState != kHasPrimary ) {
    MSG("Lat",Msg::kWarning) << "Lattice not ready for secondaries " 
                             <<endl;
    return kFALSE;
  }
  


// Retrieve primary using key and record pair in Lattice.

  if ( fKeyMap.count(key) == 0 ) {
    MSG("Lat",Msg::kWarning) << "No primary for key " << key <<endl;
    return kFALSE;
  }

  fLattice->Connect(fPrimarySide, fKeyMap[key], 0, secondaryID);
  fState = kHasSecondary;
  return kTRUE;


}

void LatticeBuilder::DockLattice	(	Lattice *	lattice,
		ESide	primarySide
	)

Definition at line 112 of file LatticeBuilder.cxx.

References fKeyMap, fLattice, fPrimarySide, fState, kFloating, and kHasLattice.

Referenced by LatticeBuilder(), LatValidate::Test_1(), and LatValidate::Test_2().

                                                      {

//  Purpose:   Dock new lattice to Builder ready for filling.
//  Arguments:
//        lattice  in    lattice to be filled (any existing lattice
//                       will be disconected).
//        primarySide
//                 in    The side of the Lattice (either kLeft or
//                       kRight) that holds the primaries.
//  Return:  n/a  

//  Contact:   N. West

// Specification:-
// =============

// o  Dock new kattice ready for building.


  fLattice       = lattice;
  fPrimarySide   = primarySide;
  fState         = fLattice ? kHasLattice : kFloating;
  fKeyMap.clear();
}

---

Member Data Documentation

map<const Key, ID> LatticeBuilder::fKeyMap [private]

Definition at line 87 of file LatticeBuilder.h.

Referenced by AddPrimary(), AddSecondary(), and DockLattice().

Lattice* LatticeBuilder::fLattice [private]

Definition at line 86 of file LatticeBuilder.h.

Referenced by AddSecondary(), and DockLattice().

ESide LatticeBuilder::fPrimarySide [private]

Definition at line 88 of file LatticeBuilder.h.

Referenced by AddSecondary(), and DockLattice().

EState LatticeBuilder::fState [private]

Definition at line 89 of file LatticeBuilder.h.

Referenced by AddPrimary(), AddSecondary(), and DockLattice().

---

The documentation for this class was generated from the following files:

• LatticeBuilder.h
• LatticeBuilder.cxx

---