VolumeTreeNavigator Class Reference

#include <VolumeTreeNavigator.h>

Inheritance diagram for VolumeTreeNavigator:

Collaboration diagram for VolumeTreeNavigator:

Public Member Functions
	VolumeTreeNavigator (const G4Step *)
void	SetDepthCutSimple (const int, const int, const int, const int)
void	SetDepthCutDetail (const char *)
VolTree	Extract ()
bool	Ascend (int levels=1)
bool	Descend (int levels=1)
bool	KillProcesses (const int, const char *,...)
int	GetCurrentDepth ()
G4VPhysicalVolume *	GetVolume (int rel=0) const
int	GetCopyNumber (int rel=0) const
const G4Track *	GetTrack () const
const G4StepPoint *	GetPreStepPoint () const
const G4StepPoint *	GetPostStepPoint () const
int	GetStepNumber () const
const VolTree &	GetHistory () const
int	GetFullDepth () const
bool	msgLvl (const MSG::Level lvl) const
	Test the output level.
MsgStream &	msg () const
	The standard message stream.
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream.
void	setLevel (MSG::Level lvl)
	Change the current logging level.

Private Member Functions
void	initMessaging () const
	Initialize our message level and MessageSvc.

Private Attributes
G4Track *	m_track
	current track
G4StepPoint *	m_preStepPoint
	volume/process/etc.
G4StepPoint *	m_postStepPoint
	volume/process/etc.
const G4TouchableHistory *	m_preHistory
	touchable history containing current volume's history
int	m_preDepth
int	m_stepNo
	depth of volume tree, step number
VolTree	m_history
	full volume history, cast as const after preparation
VolNav	m_h_end
	specifies cut termination in history
VolNav	m_h_nav
	VolTree iterator with no access below cut.
std::string	m_nm
	Message source name.
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels)
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer.
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level.
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging)

Detailed Description

Definition at line 39 of file VolumeTreeNavigator.h.

Constructor & Destructor Documentation

VolumeTreeNavigator()

VolumeTreeNavigator::VolumeTreeNavigator

(

const G4Step *

aStep

)

Definition at line 35 of file VolumeTreeNavigator.cxx.

                                                            :
  AthMessaging("VolumeTreeNavigator"),
  m_track(0), m_preHistory(0), m_preDepth(0), m_stepNo(0)
 
{
  // collect full set of volume tree data
  m_track = aStep->GetTrack();
  m_preStepPoint = aStep->GetPreStepPoint();
  m_postStepPoint = aStep->GetPostStepPoint();
  m_preHistory = dynamic_cast<const G4TouchableHistory*>(m_preStepPoint->GetTouchable());
  if (not m_preHistory){
    ATH_MSG_ERROR("Dynamic cast failed in VolumeTreeNavigator::VolumeTreeNavigator");
    return;
  }
  m_preDepth = m_preHistory->GetHistoryDepth();
  m_stepNo = m_track->GetCurrentStepNumber();
 
  if (!m_history.empty()) m_history.clear();
 
  // consolidate volume data into a vector
  for (G4int c = m_preDepth; c + 1 != 0; c--) {
      G4VPhysicalVolume* thPV = m_preHistory->GetVolume(c);
      int thPVRep = (int)(thPV->GetCopyNo());
      pair<G4VPhysicalVolume*, int> thPVID = make_pair(thPV, thPVRep);
      m_history.push_back(thPVID);
  }
  ATH_MSG_DEBUG("history size: "<< m_history.size());
 
  // Set h_end to specify full history unless otherwise chosen by DepthCut functions, and
  // set h_nav to start at the lowest accessible level, h_end - 1.
  m_h_end = m_history.end();
  m_h_nav = m_h_end-1;
}

Member Function Documentation

Ascend()

bool VolumeTreeNavigator::Ascend

(

int

levels = 1

)

Definition at line 137 of file VolumeTreeNavigator.cxx.

                                           {
  // Move up # of levels given in the navigable history, stop at Atlas::Atlas
  if ( !m_history.empty() )
  {
      if ( distance( m_history.begin(), m_h_nav ) == 0 || levels == 0 )  return 0;
      else if ( abs(levels) > abs(distance( m_history.begin(), m_h_nav )) )
          levels = abs(distance( m_history.begin(), m_h_nav ));
      advance(m_h_nav, -abs(levels));
      return 1;
  }
  else return 0;
}

Descend()

bool VolumeTreeNavigator::Descend

(

int

levels = 1

)

Definition at line 150 of file VolumeTreeNavigator.cxx.

{
  // Move down # of levels given in the navigable history
  if ( !m_history.empty() )
  {
      if ( distance(m_h_nav, m_h_end) == 1 || levels == 0 )  return 0;
      else if ( abs(levels) > abs(distance( m_h_nav, m_h_end-1 )) )
          levels = abs(distance( m_h_nav, m_h_end-1 ));
      advance(m_h_nav, abs(levels));
      return 1;
  } 
  else return 0;
}

Extract()

VolTree VolumeTreeNavigator::Extract

(

)

Definition at line 126 of file VolumeTreeNavigator.cxx.

{
  // Derive a permanent VolTree object from the current volume and its history
  VolTree ret;
  for (VolNav t = m_history.begin(); t != m_h_nav+1; ++t) {
      ret.push_back(*t);
  }
  ATH_MSG_DEBUG("VolumeTreeNavigator::Extract succeeded for "<< m_h_nav->first->GetName() <<".");
  return ret;
}

GetCopyNumber()

int VolumeTreeNavigator::GetCopyNumber

(

int

rel = 0

)

const

GetCurrentDepth()

int VolumeTreeNavigator::GetCurrentDepth

(

)

GetFullDepth()

int VolumeTreeNavigator::GetFullDepth

(

)

const

GetHistory()

const VolTree & VolumeTreeNavigator::GetHistory

(

)

const

GetPostStepPoint()

const G4StepPoint * VolumeTreeNavigator::GetPostStepPoint

(

)

const

GetPreStepPoint()

const G4StepPoint * VolumeTreeNavigator::GetPreStepPoint

(

)

const

GetStepNumber()

int VolumeTreeNavigator::GetStepNumber

(

)

const

GetTrack()

const G4Track * VolumeTreeNavigator::GetTrack

(

)

const

GetVolume()

G4VPhysicalVolume * VolumeTreeNavigator::GetVolume

(

int

rel = 0

)

const

initMessaging()

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

{
  m_imsg = Athena::getMessageSvc();
  // If user did not set an explicit level, set a default
  if (m_lvl == MSG::NIL) {
    m_lvl = m_imsg ?
      static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
      MSG::INFO;
  }
}

KillProcesses()

bool VolumeTreeNavigator::KillProcesses	(	const int	numProc,
		const char *	pr1,
			... )

Definition at line 164 of file VolumeTreeNavigator.cxx.

{
  // Checks for disallowed processes, and if found returns true; accepts arbitrary number
  // of process names.
  const G4VProcess* pds = m_postStepPoint->GetProcessDefinedStep();
  va_list procs;
 
  if ( pds ) {
      std::string name_string = stringify( pds->GetProcessName() );
      const char* name = name_string.c_str();
      va_start(procs, pr1);
      for ( int i = 0; i != numProc; i++ ) {
          if ( name == va_arg(procs, const char*) ) {
              ATH_MSG_DEBUG(name <<" process triggered - return");
              va_end(procs);
              return 1;
          }
      }
      va_end(procs);
  }
  return 0;
}

msg() [1/2]

MsgStream & AthMessaging::msg ( ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 167 of file AthMessaging.h.

{
  MsgStream* ms = m_msg_tls.get();
  if (!ms) {
    if (!m_initialized.test_and_set()) initMessaging();
    ms = new MsgStream(m_imsg,m_nm);
    m_msg_tls.reset( ms );
  }
 
  ms->setLevel (m_lvl);
  return *ms;
}

msg() [2/2]

MsgStream & AthMessaging::msg ( const MSG::Level lvl ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 182 of file AthMessaging.h.

{ return msg() << lvl; }

msgLvl()

bool AthMessaging::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Test the output level.

Parameters

lvl	The message level to test against

Returns

boolean Indicating if messages at given level will be printed

Return values

true	Messages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

{
  // If user did not set explicit message level we have to initialize
  // the messaging and retrieve the default via the MessageSvc.
  if (m_lvl==MSG::NIL && !m_initialized.test_and_set()) initMessaging();
 
  if (m_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

SetDepthCutDetail()

void VolumeTreeNavigator::SetDepthCutDetail

(

const char *

cpath

)

Definition at line 92 of file VolumeTreeNavigator.cxx.

{
  static const vector<string> volumes = [&]() {
      vector<string> v;
      msg() << MSG::INFO <<"SetDepthCutDetail path parsed as ";
      string path = stringify(cpath);
      string::size_type slash = 0;
      string::size_type start = path.find_first_not_of( '/' );
      while ( slash != string::npos ) {
          start = slash+1;
          slash = path.find_first_of( '/', start );
          v.push_back( path.substr(start, slash-start) );
          msg() << MSG::INFO <<"/"<<volumes.back();
      }
      msg() << endmsg;
      return v;
  }();
 
  m_h_nav = m_h_end;
  vector<string>::const_iterator v_nav = volumes.begin();
  advance( v_nav, distance( m_history.begin(), m_h_nav ) );
  while ( v_nav != volumes.end() && m_h_nav != m_history.end() ) {
      if ( *v_nav == stringify( m_h_nav->first->GetName() ) ) {
          ++m_h_nav;
          ++v_nav; }
      else {
          break; }
  }
  m_h_end = m_h_nav;
  m_h_nav = m_h_end-1;
  ATH_MSG_INFO("VolumeTreeNavigator::SetDepthCutDetail at "<< m_h_nav->first->GetName());
  return;
}

SetDepthCutSimple()

void VolumeTreeNavigator::SetDepthCutSimple	(	const int	CALO,
		const int	BeamPipe,
		const int	IDET,
		const int	MUONQ02 )

Definition at line 69 of file VolumeTreeNavigator.cxx.

{
  unsigned int cut = m_history.size();
  if ( m_history.size() > 1 ) {
      const string name = stringify(m_history[1].first->GetName());
      if (name == "CALO::CALO")         cut = CALO+1;
      else if (name == "BeamPipe::BeamPipe")    cut = BeamPipe+1;
      else if (name == "IDET::IDET" || name == "ITK::ITK")      cut = IDET+1;
      else if (name == "MUONQ02::MUONQ02")  cut = MUONQ02+1;
      else { ATH_MSG_INFO("Level 1 volume not found, output default depth"); }
  }
  else if ( m_history.empty() ) {
      ATH_MSG_FATAL("No volumes in history, run will terminate!");
  }
 
  if ( cut > m_history.size() )  cut = m_history.size();
  m_h_end = m_history.begin();
  advance(m_h_end, cut);
  m_h_nav = m_h_end-1;
  ATH_MSG_DEBUG("VolumeTreeNavigator::SetDepthCutSimple at "<< m_h_nav->first->GetName());
  return;
}

setLevel()

void AthMessaging::setLevel ( MSG::Level lvl )

inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

{
  m_lvl = lvl;
}

Member Data Documentation

ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT

mutableprivateinherited

Messaging initialized (initMessaging)

Definition at line 141 of file AthMessaging.h.

m_h_end

VolNav VolumeTreeNavigator::m_h_end

private

specifies cut termination in history

Definition at line 68 of file VolumeTreeNavigator.h.

m_h_nav

VolNav VolumeTreeNavigator::m_h_nav

private

VolTree iterator with no access below cut.

Definition at line 69 of file VolumeTreeNavigator.h.

m_history

VolTree VolumeTreeNavigator::m_history

private

full volume history, cast as const after preparation

Definition at line 67 of file VolumeTreeNavigator.h.

m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

{ nullptr };

m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

{ MSG::NIL };

m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls

mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels)

Definition at line 132 of file AthMessaging.h.

m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

m_postStepPoint

G4StepPoint* VolumeTreeNavigator::m_postStepPoint

private

volume/process/etc.

info after the current step

Definition at line 63 of file VolumeTreeNavigator.h.

m_preDepth

int VolumeTreeNavigator::m_preDepth

private

Definition at line 65 of file VolumeTreeNavigator.h.

m_preHistory

const G4TouchableHistory* VolumeTreeNavigator::m_preHistory

private

touchable history containing current volume's history

Definition at line 64 of file VolumeTreeNavigator.h.

m_preStepPoint

G4StepPoint* VolumeTreeNavigator::m_preStepPoint

private

volume/process/etc.

info before the current step

Definition at line 62 of file VolumeTreeNavigator.h.

m_stepNo

int VolumeTreeNavigator::m_stepNo

private

depth of volume tree, step number

Definition at line 65 of file VolumeTreeNavigator.h.

m_track

G4Track* VolumeTreeNavigator::m_track

private

current track

Definition at line 61 of file VolumeTreeNavigator.h.

---

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

• VolumeTreeNavigator.h
• VolumeTreeNavigator.cxx