DD4hep  1.30.0
Detector Description Toolkit for High Energy Physics
Public Member Functions | List of all members
dd4hep::PlacedVolumeScanner Class Reference

Helper to run placement scan through volume hierarchies scans. More...

#include <VolumeProcessor.h>

Public Member Functions

 PlacedVolumeScanner ()=default
 Default constructor. More...
 
 PlacedVolumeScanner (const PlacedVolumeScanner &copy)=default
 Copy constructor. More...
 
PlacedVolumeScanneroperator= (const PlacedVolumeScanner &copy)=default
 Assignment operator. More...
 
template<typename Q >
 PlacedVolumeScanner (Q &proc, DetElement start, int level=0, bool recursive=true)
 Constructor performing the scan internally. More...
 
template<typename Q >
 PlacedVolumeScanner (const Q &proc, DetElement start, int level=0, bool recursive=true)
 Constructor performing the scan internally. More...
 
template<typename Q >
 PlacedVolumeScanner (Q &proc, PlacedVolume start, int level=0, bool recursive=true)
 Constructor performing the scan internally. More...
 
template<typename Q >
 PlacedVolumeScanner (const Q &proc, PlacedVolume start, int level=0, bool recursive=true)
 Constructor performing the scan internally. More...
 
int scanPlacements (PlacedVolumeProcessor &proc, PlacedVolume start, int level=0, bool recursive=true) const
 PlacedVolume element tree scanner using wrapped PlacedVolumeProcessor objects. More...
 
template<typename Q >
int scan (Q &p, PlacedVolume start, int level=0, bool recursive=true) const
 PlacedVolume element tree scanner using wrapped PlacedVolumeProcessor objects. More...
 
template<typename Q >
int scan (const Q &p, PlacedVolume start, int level=0, bool recursive=true) const
 PlacedVolume element tree scanner using wrapped PlacedVolumeProcessor objects. More...
 

Detailed Description

Helper to run placement scan through volume hierarchies scans.

This wrapper converts any object, which has the signature int operator()(DetElement de, int level) const The object is automatically wrapped to a PlacedVolumeProcessor and the PlacedVolume tree is scanned depending on the scanning arguments.

Author
M.Frank
Version
1.0
Date
01/04/2016

Definition at line 135 of file VolumeProcessor.h.

Constructor & Destructor Documentation

◆ PlacedVolumeScanner() [1/6]

dd4hep::PlacedVolumeScanner::PlacedVolumeScanner ( )
default

Default constructor.

◆ PlacedVolumeScanner() [2/6]

dd4hep::PlacedVolumeScanner::PlacedVolumeScanner ( const PlacedVolumeScanner copy)
default

Copy constructor.

◆ PlacedVolumeScanner() [3/6]

template<typename Q >
dd4hep::PlacedVolumeScanner::PlacedVolumeScanner ( Q &  proc,
DetElement  start,
int  level = 0,
bool  recursive = true 
)
inline

Constructor performing the scan internally.

Definition at line 146 of file VolumeProcessor.h.

◆ PlacedVolumeScanner() [4/6]

template<typename Q >
dd4hep::PlacedVolumeScanner::PlacedVolumeScanner ( const Q &  proc,
DetElement  start,
int  level = 0,
bool  recursive = true 
)
inline

Constructor performing the scan internally.

Definition at line 151 of file VolumeProcessor.h.

◆ PlacedVolumeScanner() [5/6]

template<typename Q >
dd4hep::PlacedVolumeScanner::PlacedVolumeScanner ( Q &  proc,
PlacedVolume  start,
int  level = 0,
bool  recursive = true 
)
inline

Constructor performing the scan internally.

Definition at line 156 of file VolumeProcessor.h.

◆ PlacedVolumeScanner() [6/6]

template<typename Q >
dd4hep::PlacedVolumeScanner::PlacedVolumeScanner ( const Q &  proc,
PlacedVolume  start,
int  level = 0,
bool  recursive = true 
)
inline

Constructor performing the scan internally.

Definition at line 161 of file VolumeProcessor.h.

Member Function Documentation

◆ operator=()

PlacedVolumeScanner& dd4hep::PlacedVolumeScanner::operator= ( const PlacedVolumeScanner copy)
default

Assignment operator.

◆ scan() [1/2]

template<typename Q >
int dd4hep::PlacedVolumeScanner::scan ( const Q &  p,
PlacedVolume  start,
int  level = 0,
bool  recursive = true 
) const
inline

PlacedVolume element tree scanner using wrapped PlacedVolumeProcessor objects.

Definition at line 176 of file VolumeProcessor.h.

◆ scan() [2/2]

template<typename Q >
int dd4hep::PlacedVolumeScanner::scan ( Q &  p,
PlacedVolume  start,
int  level = 0,
bool  recursive = true 
) const
inline

PlacedVolume element tree scanner using wrapped PlacedVolumeProcessor objects.

Definition at line 170 of file VolumeProcessor.h.

◆ scanPlacements()

int dd4hep::PlacedVolumeScanner::scanPlacements ( PlacedVolumeProcessor proc,
PlacedVolume  start,
int  level = 0,
bool  recursive = true 
) const
inline

PlacedVolume element tree scanner using wrapped PlacedVolumeProcessor objects.

Definition at line 165 of file VolumeProcessor.h.


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