GeoVisitVolumes.h File Reference

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

#include "GeoPrimitives/GeoPrimitives.h"
#include "GeoModelKernel/GeoNodeAction.h"
#include "GeoModelKernel/GeoDefinitions.h"
#include <vector>
#include <variant>

Include dependency graph for GeoVisitVolumes.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	IGeoVisitVolumesAction
	Define a simple callback for each volume found. More...
class	IGeoVisitVolumesNoXformAction
	Define a simple callback for each volume found, without keeping track of geometrical transforms. More...
class	GeoVisitVolumes
	Visitor to process all volumes under a GeoModel node. More...
class	GeoVisitVolumesAction< FUNCTION >
	Callback object calling a templated functional. More...
class	GeoVisitVolumesNoXformAction< FUNCTION >
	Callback object calling a templated functional. More...

Typedefs
typedef std::vector< std::pair< const GeoVPhysVol *, GeoTrf::Transform3D > >	GeoVolumeVec_t
	Return the child volumes and associated transforms. More...

Functions
template<class FUNCTION >
void	geoVisitVolumes (FUNCTION f, const GeoGraphNode *node, int depthLimit=1)
	Template helper for running the visitor. More...
template<class FUNCTION >
void	geoVisitVolumesNoXform (FUNCTION f, const GeoGraphNode *node, int depthLimit=1)
	Template helper for running the visitor. More...
GeoVolumeVec_t	geoGetVolumes (const GeoGraphNode *node, int depthLimit=1, int sizeHint=20)
	Return the child volumes and associated transforms. More...
std::vector< const GeoVPhysVol * >	geoGetVolumesNoXform (const GeoGraphNode *node, int depthLimit=1, int sizeHint=20)
	Return the child volumes. More...

Detailed Description

Visitor to process all volumes under a GeoModel node.

Author

scott snyder snyde.nosp@m.r@bn.nosp@m.l.gov

Date

Jul, 2019 Based on GeoAccessVolumeAction.

Definition in file GeoVisitVolumes.h.

Typedef Documentation

GeoVolumeVec_t

typedef std::vector<std::pair<const GeoVPhysVol*, GeoTrf::Transform3D> > GeoVolumeVec_t

Return the child volumes and associated transforms.

Parameters

node	Root of the graph to traverse.
depthLimit	Depth limit for the traversal.
sizeHint	Hint about the number of volumes to be returned, to allow avoiding resizes of the output vector.

Returns a vector of (volume, transform) pairs for volumes in the graph. The same volume may be returned multiple times with different transforms in the case of a GeoSerialTransform.

Definition at line 219 of file GeoVisitVolumes.h.

Function Documentation

geoGetVolumes()

GeoVolumeVec_t geoGetVolumes	(	const GeoGraphNode *	node,
		int	depthLimit,
		int	sizeHint
	)

Return the child volumes and associated transforms.

Parameters

node	Root of the graph to traverse.
depthLimit	Depth limit for the traversal.
sizeHint	Hint about the number of volumes to be returned, to allow avoiding resizes of the output vector.

Returns a vector of (volume, transform) pairs for volumes in the graph. The same volume may be returned multiple times with different transforms in the case of a GeoSerialTransform.

Definition at line 211 of file GeoVisitVolumes.cxx.

{
  GeoVolumeVec_t ret;
  ret.reserve (sizeHint);
  geoVisitVolumes ([&] (int /*id*/,
                        const std::string& /*name*/,
                        const GeoVPhysVol* volume,
                        const GeoTrf::Transform3D& transform,
                        const GeoTrf::Transform3D& /*defTransform*/)
                   { ret.emplace_back (volume, transform); },
                   node,
                   depthLimit);
  return ret;
}

geoGetVolumesNoXform()

std::vector<const GeoVPhysVol*> geoGetVolumesNoXform	(	const GeoGraphNode *	node,
		int	depthLimit,
		int	sizeHint
	)

Return the child volumes.

Parameters

node	Root of the graph to traverse.
depthLimit	Depth limit for the traversal.
sizeHint	Hint about the number of volumes to be returned, to allow avoiding resizes of the output vector.

Returns a vector of volumes in the graph. The same volume may be returned multiple times in the case of a GeoSerialTransform.

Definition at line 240 of file GeoVisitVolumes.cxx.

{
  std::vector<const GeoVPhysVol*> ret;
  ret.reserve (sizeHint);
  geoVisitVolumesNoXform ([&] (int /*id*/,
                               const std::string& /*name*/,
                               const GeoVPhysVol* volume)
                   { ret.push_back (volume); },
                   node,
                   depthLimit);
  return ret;
}

geoVisitVolumes()

template<class FUNCTION >

void geoVisitVolumes	(	FUNCTION	f,
		const GeoGraphNode *	node,
		int	depthLimit = 1
	)

Template helper for running the visitor.

Definition at line 185 of file GeoVisitVolumes.h.

{
  GeoVisitVolumesAction<FUNCTION> act (f);
  GeoVisitVolumes visitor (act, depthLimit);
  node->exec (&visitor);
}

geoVisitVolumesNoXform()

template<class FUNCTION >

void geoVisitVolumesNoXform	(	FUNCTION	f,
		const GeoGraphNode *	node,
		int	depthLimit = 1
	)

Template helper for running the visitor.

This version doesn't supply transformation information.

Definition at line 199 of file GeoVisitVolumes.h.

{
  GeoVisitVolumesNoXformAction<FUNCTION> act (f);
  GeoVisitVolumes visitor (act, depthLimit);
  node->exec (&visitor);
}