GeoVisitVolumes Class Reference

Visitor to process all volumes under a GeoModel node. More...

#include <GeoVisitVolumes.h>

Inheritance diagram for GeoVisitVolumes:

Collaboration diagram for GeoVisitVolumes:

Public Member Functions
	GeoVisitVolumes (IGeoVisitVolumesAction &action, int depthLimit=1)
	Initialize to visit volumes keeping track of transformations.
	GeoVisitVolumes (IGeoVisitVolumesNoXformAction &action, int depthLimit=1)
	Initialize to visit volumes withoutkeeping track of transformations.
virtual void	handleTransform (const GeoTransform *xform) override
	Handles a Transform.
virtual void	handlePhysVol (const GeoPhysVol *vol) override
	Handles a physical volume.
virtual void	handleFullPhysVol (const GeoFullPhysVol *vol) override
	Handles a physical volume.
virtual void	handleNameTag (const GeoNameTag *nameTag) override
	Handles a Name Tag.
virtual void	handleSerialDenominator (const GeoSerialDenominator *sD) override
	Handles a Serial Denominator.
virtual void	handleSerialTransformer (const GeoSerialTransformer *sT) override
	Handles a Serial Transformer.
virtual void	handleIdentifierTag (const GeoIdentifierTag *idTag) override
	Handles an Identifier Tag.
virtual void	handleSerialIdentifier (const GeoSerialIdentifier *sI) override
	Handles an Serial Identifier.

Private Member Functions
	GeoVisitVolumes (const GeoVisitVolumes &right)=delete
GeoVisitVolumes &	operator= (const GeoVisitVolumes &right)=delete
void	handleVol (const GeoVPhysVol *vol)

Private Attributes
std::variant< IGeoVisitVolumesAction *, IGeoVisitVolumesNoXformAction * >	m_action
	Callback.
const GeoNameTag *	m_nameTag
	A pointer to a name tag. If the volume is named.
const GeoSerialDenominator *	m_serialDenominator
	A pointer to a serial denominator. If one exists.
const GeoIdentifierTag *	m_idTag
	A pointer to an identifier tag. If the volume is identified.
std::vector< const GeoTransform * >	m_pendingTransformList
	List of Pending Transformations.
const GeoSerialIdentifier *	m_serialIdentifier

Detailed Description

Visitor to process all volumes under a GeoModel node.

Can take either an IGeoVisitVolumesAction or an IGeoVisitVolumesNoXformAction. In the latter case, we don't keep track of the geometrical transforms. It can be used as a faster option if you only care about the list of volumes but not where they're located.

Definition at line 76 of file GeoVisitVolumes.h.

Constructor & Destructor Documentation

GeoVisitVolumes() [1/3]

GeoVisitVolumes::GeoVisitVolumes	(	IGeoVisitVolumesAction &	action,
		int	depthLimit = 1 )

Initialize to visit volumes keeping track of transformations.

Definition at line 23 of file GeoVisitVolumes.cxx.

  : m_action(&action)
  , m_nameTag(nullptr)
  , m_serialDenominator(nullptr)
  , m_idTag(nullptr)
  , m_serialIdentifier(nullptr)
{
  setDepthLimit (depthLimit);
  m_pendingTransformList.reserve(1);
}

GeoVisitVolumes() [2/3]

GeoVisitVolumes::GeoVisitVolumes	(	IGeoVisitVolumesNoXformAction &	action,
		int	depthLimit = 1 )

Initialize to visit volumes withoutkeeping track of transformations.

Definition at line 36 of file GeoVisitVolumes.cxx.

  : m_action(&action)
  , m_nameTag(nullptr)
  , m_serialDenominator(nullptr)
  , m_idTag(nullptr)
  , m_serialIdentifier(nullptr)
{
  setDepthLimit (depthLimit);
}

GeoVisitVolumes() [3/3]

GeoVisitVolumes::GeoVisitVolumes ( const GeoVisitVolumes & right )

privatedelete

Member Function Documentation

handleFullPhysVol()

void GeoVisitVolumes::handleFullPhysVol ( const GeoFullPhysVol * vol )

overridevirtual

Handles a physical volume.

Definition at line 103 of file GeoVisitVolumes.cxx.

{
  handleVol (vol);
}

handleIdentifierTag()

void GeoVisitVolumes::handleIdentifierTag ( const GeoIdentifierTag * idTag )

overridevirtual

Handles an Identifier Tag.

Definition at line 187 of file GeoVisitVolumes.cxx.

{
  m_idTag = idTag;
  m_serialIdentifier = nullptr;
}

handleNameTag()

void GeoVisitVolumes::handleNameTag ( const GeoNameTag * nameTag )

overridevirtual

Handles a Name Tag.

Definition at line 109 of file GeoVisitVolumes.cxx.

{
  m_nameTag = nameTag;
  m_serialDenominator = nullptr;
}

handlePhysVol()

void GeoVisitVolumes::handlePhysVol ( const GeoPhysVol * vol )

overridevirtual

Handles a physical volume.

Definition at line 98 of file GeoVisitVolumes.cxx.

{
  handleVol (vol);
}

handleSerialDenominator()

void GeoVisitVolumes::handleSerialDenominator ( const GeoSerialDenominator * sD )

overridevirtual

Handles a Serial Denominator.

Definition at line 116 of file GeoVisitVolumes.cxx.

{
  m_serialDenominator = sD;
}

handleSerialIdentifier()

void GeoVisitVolumes::handleSerialIdentifier ( const GeoSerialIdentifier * sI )

overridevirtual

Handles an Serial Identifier.

Definition at line 194 of file GeoVisitVolumes.cxx.

{
  m_serialIdentifier = sI;
}

handleSerialTransformer()

void GeoVisitVolumes::handleSerialTransformer ( const GeoSerialTransformer * sT )

overridevirtual

Handles a Serial Transformer.

Definition at line 130 of file GeoVisitVolumes.cxx.

{
  const GeoVPhysVol* vol = &*sT->getVolume();
  unsigned int ncopies = sT->getNCopies();
  int idbase = -1;
  if (m_serialIdentifier) {
    idbase = m_serialIdentifier->getBaseId();
  }
 
  GeoTrf::Transform3D transform; 
  GeoTrf::Transform3D defTransform;
  if (m_action.index() == 0) {
    if (m_pendingTransformList.size() == 0) {
      transform = GeoTrf::Transform3D::Identity();
      defTransform = GeoTrf::Transform3D::Identity();
    }
    else {
      transform = m_pendingTransformList[0]->getTransform(nullptr);
      defTransform = m_pendingTransformList[0]->getDefTransform(nullptr);
      for (size_t i = 1; i < m_pendingTransformList.size(); ++i) {
        const GeoTransform* t = m_pendingTransformList[i];
        transform    = transform    * t->getTransform(nullptr);
        defTransform = defTransform * t->getDefTransform(nullptr);
      }
    }
  }
 
  for (unsigned int i = 0; i < ncopies; i++) {
    int id = idbase;
    if (id >= 0) {
      id += i;
    }
 
    std::string name;
    if (m_serialDenominator) {
      name = m_serialDenominator->getBaseName() + std::to_string(i);
    }
    else {
      name = "ANON";
    }
 
    if (m_action.index() == 0) {
      (*std::get<0>(m_action)) (*this, id, name, vol,
                                transform * sT->getTransform (i),
                                defTransform * sT->getTransform (i));
    }
    else {
      (*std::get<1>(m_action)) (*this, id, name, vol);
    }
  }
 
  m_idTag   = nullptr;
  m_nameTag = nullptr;
  m_pendingTransformList.clear();
}

handleTransform()

void GeoVisitVolumes::handleTransform ( const GeoTransform * xform )

overridevirtual

Handles a Transform.

Definition at line 48 of file GeoVisitVolumes.cxx.

{
  if (m_action.index() == 0)
    m_pendingTransformList.push_back (xform);
}

handleVol()

void GeoVisitVolumes::handleVol ( const GeoVPhysVol * vol )

private

Definition at line 55 of file GeoVisitVolumes.cxx.

{
  //
  // Return if we have not got to any children:
  //
  if(getPath()->getLength()-1 == 0)
    return;
 
  const static std::string anon = "ANON";
  const std::string& name = m_nameTag ? m_nameTag->getName() : anon;
 
  int id = m_idTag ? m_idTag->getIdentifier() : -1;
 
  if (m_action.index() == 0) {
    GeoTrf::Transform3D transform;
    GeoTrf::Transform3D defTransform;
 
    if (m_pendingTransformList.size() == 0) {
      transform = GeoTrf::Transform3D::Identity();
      defTransform = GeoTrf::Transform3D::Identity();
    }
    else {
      transform = m_pendingTransformList[0]->getTransform(nullptr);
      defTransform = m_pendingTransformList[0]->getDefTransform(nullptr);
      for (size_t i = 1; i < m_pendingTransformList.size(); ++i) {
        const GeoTransform* t = m_pendingTransformList[i];
        transform    = transform    * t->getTransform(nullptr);
        defTransform = defTransform * t->getDefTransform(nullptr);
      }
    }
 
    (*std::get<0>(m_action)) (*this, id, name, vol, transform, defTransform);
    m_pendingTransformList.clear();
  }
  else {
    (*std::get<1>(m_action)) (*this, id, name, vol);
  }
 
  m_idTag   = nullptr;
  m_nameTag = nullptr;
}

operator=()

GeoVisitVolumes & GeoVisitVolumes::operator= ( const GeoVisitVolumes & right )

privatedelete

Member Data Documentation

m_action

std::variant<IGeoVisitVolumesAction*, IGeoVisitVolumesNoXformAction*> GeoVisitVolumes::m_action

private

Callback.

Definition at line 118 of file GeoVisitVolumes.h.

m_idTag

const GeoIdentifierTag* GeoVisitVolumes::m_idTag

private

A pointer to an identifier tag. If the volume is identified.

Definition at line 127 of file GeoVisitVolumes.h.

m_nameTag

const GeoNameTag* GeoVisitVolumes::m_nameTag

private

A pointer to a name tag. If the volume is named.

Definition at line 121 of file GeoVisitVolumes.h.

m_pendingTransformList

std::vector<const GeoTransform *> GeoVisitVolumes::m_pendingTransformList

private

List of Pending Transformations.

Definition at line 130 of file GeoVisitVolumes.h.

m_serialDenominator

const GeoSerialDenominator* GeoVisitVolumes::m_serialDenominator

private

A pointer to a serial denominator. If one exists.

Definition at line 124 of file GeoVisitVolumes.h.

m_serialIdentifier

const GeoSerialIdentifier* GeoVisitVolumes::m_serialIdentifier

private

Definition at line 132 of file GeoVisitVolumes.h.

---

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

• GeoVisitVolumes.h
• GeoVisitVolumes.cxx