G4NavigationHistory Class Reference

#include <G4NavigationHistory.hh>

Public Member Functions
	G4NavigationHistory ()
	~G4NavigationHistory ()
	G4NavigationHistory (const G4NavigationHistory &h)
G4NavigationHistory &	operator= (const G4NavigationHistory &h)
void	Reset ()
void	Clear ()
void	SetFirstEntry (G4VPhysicalVolume *pVol)
const G4AffineTransform &	GetTopTransform () const
const G4AffineTransform *	GetPtrTopTransform () const
G4int	GetTopReplicaNo () const
EVolume	GetTopVolumeType () const
G4VPhysicalVolume *	GetTopVolume () const
G4int	GetDepth () const
G4int	GetMaxDepth () const
const G4AffineTransform &	GetTransform (G4int n) const
G4int	GetReplicaNo (G4int n) const
EVolume	GetVolumeType (G4int n) const
G4VPhysicalVolume *	GetVolume (G4int n) const
void	NewLevel (G4VPhysicalVolume *pNewMother, EVolume vType=kNormal, G4int nReplica=-1)
void	BackLevel ()
void	BackLevel (G4int n)
Friends
std::ostream &	operator<< (std::ostream &os, const G4NavigationHistory &h)

---

Detailed Description

Definition at line 56 of file G4NavigationHistory.hh.

---

Constructor & Destructor Documentation

G4NavigationHistory::G4NavigationHistory

(

)

Definition at line 48 of file G4NavigationHistory.cc.

References Clear().

  : fNavHistory(kHistoryMax), fStackDepth(0)
{
  Clear();
}

G4NavigationHistory::~G4NavigationHistory

(

)

Definition at line 59 of file G4NavigationHistory.cc.

{
}

G4NavigationHistory::G4NavigationHistory

(

const G4NavigationHistory &

h

)

Definition at line 54 of file G4NavigationHistory.cc.

  : fNavHistory(h.fNavHistory), fStackDepth(h.fStackDepth)
{
}

---

Member Function Documentation

void G4NavigationHistory::BackLevel

(

G4int

n

)

[inline]

Definition at line 171 of file G4NavigationHistory.icc.

{
  assert( n<=fStackDepth );
  fStackDepth-=n;
}

void G4NavigationHistory::BackLevel

(

)

[inline]

Definition at line 160 of file G4NavigationHistory.icc.

Referenced by G4ReplicaNavigation::BackLocate(), G4VoxelNavigation::LevelLocate(), G4ParameterisedNavigation::LevelLocate(), G4NormalNavigation::LevelLocate(), G4Navigator::LocateGlobalPointAndSetup(), G4ITNavigator::LocateGlobalPointAndSetup(), and G4TouchableHistory::MoveUpHistory().

{
  assert( fStackDepth>0 );

  // Tell  the  level  that I am forgetting it
  // delete fNavHistory(fStackDepth);
  //
  fStackDepth--;
}

void G4NavigationHistory::Clear

(

)

[inline]

Definition at line 62 of file G4NavigationHistory.icc.

References kNormal, and Reset().

Referenced by G4NavigationHistory().

{
  G4AffineTransform origin(G4ThreeVector(0.,0.,0.));
  G4NavigationLevel tmpNavLevel = G4NavigationLevel(0, origin, kNormal, -1) ;

  Reset();
  for (register G4int ilev=fNavHistory.size()-1; ilev>=0; ilev--)
  {
     fNavHistory[ilev] = tmpNavLevel;
  }
}

G4int G4NavigationHistory::GetDepth

(

)

const [inline]

Definition at line 123 of file G4NavigationHistory.icc.

Referenced by G4ReplicaNavigation::BackLocate(), G4ReplicaNavigation::ComputeSafety(), G4ReplicaNavigation::ComputeStep(), G4Navigator::ComputeStep(), G4RegularNavigation::ComputeStepSkippingEqualMaterials(), G4TouchableHistory::GetHistoryDepth(), G4Navigator::LocateGlobalPointAndSetup(), G4ITNavigator::LocateGlobalPointAndSetup(), G4TouchableHistory::MoveUpHistory(), operator<<(), G4Navigator::SetupHierarchy(), and G4ITNavigator::SetupHierarchy().

{
  return fStackDepth;
}

G4int G4NavigationHistory::GetMaxDepth

(

)

const [inline]

Definition at line 154 of file G4NavigationHistory.icc.

{
  return fNavHistory.size();
}

const G4AffineTransform * G4NavigationHistory::GetPtrTopTransform

(

)

const [inline]

Definition at line 93 of file G4NavigationHistory.icc.

{
  return fNavHistory[fStackDepth].GetPtrTransform();
}

G4int G4NavigationHistory::GetReplicaNo

(

G4int

n

)

const [inline]

Definition at line 136 of file G4NavigationHistory.icc.

Referenced by G4ReplicaNavigation::BackLocate(), G4ReplicaNavigation::ComputeSafety(), G4ReplicaNavigation::ComputeStep(), G4TouchableHistory::GetReplicaNumber(), operator<<(), G4Navigator::SetupHierarchy(), and G4ITNavigator::SetupHierarchy().

{
  return fNavHistory[n].GetReplicaNo();
}

G4int G4NavigationHistory::GetTopReplicaNo

(

)

const [inline]

Definition at line 105 of file G4NavigationHistory.icc.

Referenced by G4ReplicaNavigation::ComputeSafety(), G4ReplicaNavigation::ComputeStep(), G4Navigator::LocateGlobalPointAndSetup(), and G4ITNavigator::LocateGlobalPointAndSetup().

{
  return fNavHistory[fStackDepth].GetReplicaNo();
}

const G4AffineTransform & G4NavigationHistory::GetTopTransform

(

)

const [inline]

Definition at line 99 of file G4NavigationHistory.icc.

Referenced by G4Navigator::ComputeLocalAxis(), G4ITNavigator::ComputeLocalAxis(), G4Navigator::ComputeLocalPoint(), G4ITNavigator::ComputeLocalPoint(), G4ReplicaNavigation::ComputeStep(), G4RegularNavigation::ComputeStep(), G4Navigator::CreateGRSSolid(), G4ITNavigator::CreateGRSSolid(), G4Navigator::CreateGRSVolume(), G4ITNavigator::CreateGRSVolume(), G4TouchableHistory::G4TouchableHistory(), G4Navigator::GetGlobalToLocalTransform(), G4ITNavigator::GetGlobalToLocalTransform(), G4Navigator::GetLocalToGlobalTransform(), G4ITNavigator::GetLocalToGlobalTransform(), G4VoxelNavigation::LevelLocate(), G4RegularNavigation::LevelLocate(), G4ParameterisedNavigation::LevelLocate(), G4NormalNavigation::LevelLocate(), G4Navigator::LocateGlobalPointAndSetup(), G4ITNavigator::LocateGlobalPointAndSetup(), G4Navigator::NetRotation(), G4ITNavigator::NetRotation(), G4Navigator::NetTranslation(), G4ITNavigator::NetTranslation(), and G4TouchableHistory::UpdateYourself().

{
  return fNavHistory[fStackDepth].GetTransform();
}

G4VPhysicalVolume * G4NavigationHistory::GetTopVolume

(

)

const [inline]

Definition at line 117 of file G4NavigationHistory.icc.

Referenced by G4VoxelNavigation::ComputeSafety(), G4ReplicaNavigation::ComputeSafety(), G4ParameterisedNavigation::ComputeSafety(), G4NormalNavigation::ComputeSafety(), G4Navigator::ComputeSafety(), G4ITNavigator::ComputeSafety(), G4VoxelNavigation::ComputeStep(), G4ReplicaNavigation::ComputeStep(), G4RegularNavigation::ComputeStep(), G4ParameterisedNavigation::ComputeStep(), G4NormalNavigation::ComputeStep(), G4Navigator::ComputeStep(), G4ITNavigator::ComputeStep(), G4Navigator::CreateGRSSolid(), G4ITNavigator::CreateGRSSolid(), G4Navigator::CreateGRSVolume(), G4ITNavigator::CreateGRSVolume(), G4Navigator::GetLocalExitNormal(), G4ITNavigator::GetLocalExitNormal(), G4VoxelNavigation::LevelLocate(), G4ReplicaNavigation::LevelLocate(), G4RegularNavigation::LevelLocate(), G4ParameterisedNavigation::LevelLocate(), G4NormalNavigation::LevelLocate(), G4Navigator::LocateGlobalPointAndSetup(), G4ITNavigator::LocateGlobalPointAndSetup(), G4Navigator::LocateGlobalPointWithinVolume(), and G4ITNavigator::LocateGlobalPointWithinVolume().

{
  return fNavHistory[fStackDepth].GetPhysicalVolume();
}

EVolume G4NavigationHistory::GetTopVolumeType

(

)

const [inline]

Definition at line 111 of file G4NavigationHistory.icc.

Referenced by G4Navigator::ComputeSafety(), G4ITNavigator::ComputeSafety(), G4Navigator::ComputeStep(), G4ITNavigator::ComputeStep(), G4Navigator::LocateGlobalPointAndSetup(), G4ITNavigator::LocateGlobalPointAndSetup(), G4Navigator::LocateGlobalPointWithinVolume(), and G4ITNavigator::LocateGlobalPointWithinVolume().

{
  return fNavHistory[fStackDepth].GetVolumeType();
}

const G4AffineTransform & G4NavigationHistory::GetTransform

(

G4int

n

)

const [inline]

Definition at line 130 of file G4NavigationHistory.icc.

Referenced by G4ReplicaNavigation::BackLocate(), G4ReplicaNavigation::ComputeSafety(), G4ReplicaNavigation::ComputeStep(), G4Navigator::ComputeStep(), G4RegularNavigation::ComputeStepSkippingEqualMaterials(), G4TouchableHistory::GetRotation(), G4TouchableHistory::GetTranslation(), and NewLevel().

{
  return fNavHistory[n].GetTransform();
}

G4VPhysicalVolume * G4NavigationHistory::GetVolume

(

G4int

n

)

const [inline]

Definition at line 148 of file G4NavigationHistory.icc.

Referenced by G4ReplicaNavigation::BackLocate(), G4ReplicaNavigation::ComputeSafety(), G4ReplicaNavigation::ComputeStep(), G4TouchableHistory::GetSolid(), G4TouchableHistory::GetVolume(), operator<<(), G4Navigator::SetupHierarchy(), and G4ITNavigator::SetupHierarchy().

{
  return fNavHistory[n].GetPhysicalVolume();
}

EVolume G4NavigationHistory::GetVolumeType

(

G4int

n

)

const [inline]

Definition at line 142 of file G4NavigationHistory.icc.

Referenced by G4ReplicaNavigation::BackLocate(), G4ReplicaNavigation::ComputeSafety(), G4ReplicaNavigation::ComputeStep(), operator<<(), G4Navigator::SetupHierarchy(), and G4ITNavigator::SetupHierarchy().

{
  return fNavHistory[n].GetVolumeType();
}

void G4NavigationHistory::NewLevel	(	G4VPhysicalVolume *	pNewMother,
		EVolume	vType = kNormal,
		G4int	nReplica = -1
	)			[inline]

Definition at line 192 of file G4NavigationHistory.icc.

References G4VPhysicalVolume::GetRotation(), GetTransform(), and G4VPhysicalVolume::GetTranslation().

Referenced by G4VoxelNavigation::LevelLocate(), G4ReplicaNavigation::LevelLocate(), G4RegularNavigation::LevelLocate(), G4ParameterisedNavigation::LevelLocate(), G4NormalNavigation::LevelLocate(), G4Navigator::LocateGlobalPointAndSetup(), and G4ITNavigator::LocateGlobalPointAndSetup().

{
  fStackDepth++;
  EnlargeHistory();  // Enlarge if required
  fNavHistory[fStackDepth] =
    G4NavigationLevel( pNewMother, 
                       fNavHistory[fStackDepth-1].GetTransform(),
                       G4AffineTransform(pNewMother->GetRotation(),
                       pNewMother->GetTranslation()),
                       vType,
                       nReplica ); 
  // The constructor computes the new global->local transform
}

G4NavigationHistory & G4NavigationHistory::operator=

(

const G4NavigationHistory &

h

)

[inline]

Definition at line 36 of file G4NavigationHistory.icc.

References fNavHistory, and fStackDepth.

{
  if (&h == this)  { return *this; }

  // fNavHistory=h.fNavHistory;   // This works, but is very slow.

  if( this->GetMaxDepth() < h.fStackDepth )
  {
    fNavHistory.resize( h.fStackDepth ); 
  }
  for ( register G4int ilev=h.fStackDepth; ilev>=0; ilev-- )
  { 
    fNavHistory[ilev] = h.fNavHistory[ilev]; 
  } 
  fStackDepth=h.fStackDepth;

  return *this;
}

void G4NavigationHistory::Reset

(

)

[inline]

Definition at line 56 of file G4NavigationHistory.icc.

Referenced by Clear(), G4Navigator::ResetStackAndState(), and G4ITNavigator::ResetStackAndState().

{
  fStackDepth=0;
}

void G4NavigationHistory::SetFirstEntry

(

G4VPhysicalVolume *

pVol

)

[inline]

Definition at line 75 of file G4NavigationHistory.icc.

References G4VPhysicalVolume::GetCopyNo(), G4VPhysicalVolume::GetTranslation(), and kNormal.

Referenced by G4TouchableHistory::G4TouchableHistory(), G4Navigator::SetWorldVolume(), G4ITNavigator::SetWorldVolume(), and G4TouchableHistory::UpdateYourself().

{
  G4ThreeVector translation(0.,0.,0.);
  G4int copyNo = -1;

  // Protection needed in case pVol=null 
  // so that a touchable-history can signal OutOfWorld 
  //
  if( pVol!=0 )
  {
    translation = pVol->GetTranslation();
    copyNo = pVol->GetCopyNo();
  }
  fNavHistory[0] =
    G4NavigationLevel( pVol, G4AffineTransform(translation), kNormal, copyNo );
}

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const G4NavigationHistory &	h
	)			[friend]

Definition at line 64 of file G4NavigationHistory.cc.

{
  G4cout << "History depth=" << nav.GetDepth() << G4endl;
  for ( G4int i=0; i<=nav.GetDepth(); i++ )
  {
    os << "Level=["<<i<<"]: ";
    if( nav.GetVolume(i) != 0 )
    {
      os << "Phys Name=["<< nav.GetVolume(i)->GetName()
         << "] Type=[";
      switch(nav.GetVolumeType(i))
      {
        case kNormal:
          os << "N";
          break;
        case kReplica:
          os << "R" << nav.GetReplicaNo(i);
          break;
        case kParameterised:
          os << "P" << nav.GetReplicaNo(i);
          break;
      }
      os << "]";
    }
    else
    {
      os << "Phys = <Null>";
    }
    os << G4endl;
  }
  return os;
}

---

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

• G4NavigationHistory.hh
• G4NavigationHistory.icc
• G4NavigationHistory.cc

---