DDCompactView Class Reference

Compact representation of the geometrical detector hierarchy. More...

#include <DDCompactView.h>

Public Types
using	Graph = math::Graph< DDLogicalPart, DDPosData * >
using	GraphWalker = math::GraphWalker< DDLogicalPart, DDPosData * >
using	Vectors = std::unordered_map< std::string, std::vector< double >>

Public Member Functions
	DDCompactView ()
	Creates a compact-view. More...
	DDCompactView (const DDName &)
	Creates a compact-view using a different root of the geometry hierarchy. More...
	DDCompactView (const DDLogicalPart &rootnodedata)
	Creates a compact-view using a different root of the geometry hierarchy. More...
const Graph &	graph () const
	Provides read-only access to the data structure of the compact-view. More...
void	lockdown ()
void	position (const DDLogicalPart &self, const DDLogicalPart &parent, const std::string &copyno, const DDTranslation &trans, const DDRotation &rot, const DDDivision *div=nullptr)
void	position (const DDLogicalPart &self, const DDLogicalPart &parent, int copyno, const DDTranslation &trans, const DDRotation &rot, const DDDivision *div=nullptr)
const DDLogicalPart &	root () const
	returns the DDLogicalPart representing the root of the geometrical hierarchy More...
void	setRoot (const DDLogicalPart &root)
std::vector< double > const &	vector (std::string_view iKey) const
	returns an empty container if not found More...
GraphWalker	walker () const
const DDPosData *	worldPosition () const
	The absolute position of the world. More...
	~DDCompactView ()

Private Member Functions
void	swap (DDCompactView &)

Private Attributes
DDI::Store< DDName, std::unique_ptr < DDI::LogicalPart > >	lpStore_
DDI::Store< DDName, std::unique_ptr< DDI::Material > >	matStore_
std::unique_ptr < DDCompactViewImpl >	rep_
DDI::Store< DDName, std::unique_ptr < DDRotationMatrix > >	rotStore_
DDI::Store< DDName, std::unique_ptr< DDI::Solid > >	solidStore_
DDI::Store< DDName, std::unique_ptr< DDI::Specific > >	specStore_
Vectors	vectors_
std::unique_ptr< DDPosData >	worldpos_

Detailed Description

Compact representation of the geometrical detector hierarchy.

Navigation through the compact view of the detector ... A DDCompactView represents the detector as an acyclic directed multigraph. The nodes are instances of DDLogicalPart while the edges are pointers to DDPosData. Edges are directed from parent-node to child-node. Edges represented by DDPosData are the relative translation and rotation accompanied by a copy-number of the child-node towards the parent-node.

One node is explicitly marked as the root node. It is the DDLogicalPart which defines the base coordinate system for the detector. All subdetectors are directly or inderectly positioned inside the root-node.

Example:

The figureshows a compact-view graph consisting of 16 DDLogicalParts interconnected by 20 edges represented by pointers to DDPosData.

The compact-view also serves as base for calculating nodes in the expanded view. Paths through the compact-view can be viewed as nodes in the expanded-view (expansion of an acyclic directed multigraph into a tree). In the figure there are 5 different paths from CMS to Module2 (e.g. CMS-Pos1->Ecal-Pos4->EEndcap-Pos21->Module2) thus there will be 5 nodes of Module2 in the expanded view.

MEC: There has been a re-purposing of the DDCompactView to not only hold the representation described above (in detail this is the DDCompactViewImpl) but also own the memory of the stores refered to by the graph.

DDCompactView now owns the DDMaterial, DDSpecific, DDLogicalPart, DDRotation, DDSolid and etc. Removal of the global one-and-only stores, methods and details such as DDRoot will mean that all of these will be accessed via the DDCompactView.

Description: DD Compact View Facade

Implementation: The DDCompactView facade serves as a launching point for a broader refactor of monolithic or tightly-coupled systems in favor of more loosely-coupled code.

Definition at line 81 of file DDCompactView.h.

Member Typedef Documentation

using DDCompactView::Graph = math::Graph<DDLogicalPart, DDPosData*>

Definition at line 83 of file DDCompactView.h.

using DDCompactView::GraphWalker = math::GraphWalker<DDLogicalPart, DDPosData*>

Definition at line 84 of file DDCompactView.h.

using DDCompactView::Vectors = std::unordered_map<std::string, std::vector<double>>

Definition at line 85 of file DDCompactView.h.

Constructor & Destructor Documentation

DDCompactView::DDCompactView ( )

explicit

Creates a compact-view.

Definition at line 100 of file DDCompactView.cc.

    : rep_(std::make_unique<DDCompactViewImpl>()),
      worldpos_(std::make_unique<DDPosData>(DDTranslation(), DDRotation(), 0)) {}

DDCompactView::DDCompactView ( const DDName &  name )

explicit

Creates a compact-view using a different root of the geometry hierarchy.

Definition at line 42 of file DDCompactView.cc.

References DDI::Singleton< I >::instance(), rep_, and worldpos_.

                                               {
  DDMaterial::StoreT::instance().setReadOnly(false);
  DDSolid::StoreT::instance().setReadOnly(false);
  DDLogicalPart::StoreT::instance().setReadOnly(false);
  DDSpecifics::StoreT::instance().setReadOnly(false);
  DDRotation::StoreT::instance().setReadOnly(false);
  rep_ = std::make_unique<DDCompactViewImpl>(DDLogicalPart(name));
  worldpos_ = std::make_unique<DDPosData>(DDTranslation(), DDRotation(), 0);
}

DDCompactView::~DDCompactView ( )

default

DDCompactView::DDCompactView ( const DDLogicalPart &  rootnodedata )

explicit

Creates a compact-view using a different root of the geometry hierarchy.

Compact-views can be created only after an appropriate geometrical hierarchy has been defined using DDpos().

Further it is assumed that the DDLogicalPart defining the root of the geometrical hierarchy has been defined using DDRootDef - singleton. It will be extracted from this singleton using DDRootDef::instance().root()!

The first time this constructor gets called, the internal graph representation is build up. Subsequent calls will return immidiately providing access to the already built up compact-view representation.

Currently the only usefull methods are DDCompactView::graph(), DDCompactView::root() !

Definition at line 38 of file DDCompactView.cc.

    : rep_(std::make_unique<DDCompactViewImpl>(rootnodedata)),
      worldpos_(std::make_unique<DDPosData>(DDTranslation(), DDRotation(), 0)) {}

Member Function Documentation

const DDCompactView::Graph & DDCompactView::graph

(

)

const

Provides read-only access to the data structure of the compact-view.

The compact-view is kept in an acyclic directed multigraph represented by an instance of class Graph<DDLogicalPart, DDPosData*). Graph provides methods for navigating its content.

Definition at line 59 of file DDCompactView.cc.

References rep_.

Referenced by PrintGeomSolids::analyze(), PrintGeomSummary::beginRun(), DDG4Builder::BuildGeometry(), DDCheckAll(), DDCheckConnect(), DDCompareCPV(), ddstats(), GeometryInfoDump::dumpInfo(), and DDErrorDetection::lp_cpv().

{ return rep_->graph(); }

void DDCompactView::lockdown

(

)

Definition at line 104 of file DDCompactView.cc.

References DDBase< DDName, std::unique_ptr< std::vector< double > > >::end(), DDI::Singleton< I >::instance(), lpStore_, matStore_, rotStore_, solidStore_, specStore_, and vectors_.

Referenced by CompareDDCompactViews::beginRun().

                             {
  // at this point we should have a valid store of DDObjects and we will move these
  // to the local storage area using swaps with the existing Singleton<Store...>'s
  DDMaterial::StoreT::instance().swap(matStore_);
  DDSolid::StoreT::instance().swap(solidStore_);
  DDLogicalPart::StoreT::instance().swap(lpStore_);
  DDSpecifics::StoreT::instance().swap(specStore_);
  DDRotation::StoreT::instance().swap(rotStore_);

  //Deal with DDVectors
  DDVector::iterator<DDVector> vit;
  DDVector::iterator<DDVector> ved(DDVector::end());

  for (; vit != ved; ++vit) {
    if (vit->isDefined().second) {
      DDName vname(vit->name());
      vectors_.emplace(vname.name(), vit->values());
    }
  }
  // NOTE: would be good to clear DDVector's container at this time
  // to avoid mixing with other DDCompactViews. Unclear if that is
  // safe to do.

  // FIXME: lock the global stores.
  DDMaterial::StoreT::instance().setReadOnly(false);
  DDSolid::StoreT::instance().setReadOnly(false);
  DDLogicalPart::StoreT::instance().setReadOnly(false);
  DDSpecifics::StoreT::instance().setReadOnly(false);
  DDRotation::StoreT::instance().setReadOnly(false);
}

void DDCompactView::position	(	const DDLogicalPart &	self,
		const DDLogicalPart &	parent,
		const std::string &	copyno,
		const DDTranslation &	trans,
		const DDRotation &	rot,
		const DDDivision *	div = nullptr
	)

Definition at line 76 of file DDCompactView.cc.

Referenced by DDHGCalTBModuleX::constructBlocks(), DDHCalBarrelAlgo::constructGeneralVolume(), DDHCalEndcapAlgo::constructGeneralVolume(), DDHCalBarrelAlgo::constructInsideDetectors(), DDHCalBarrelAlgo::constructInsideLayers(), DDHCalEndcapModuleAlgo::constructInsideModule(), DDHCalEndcapAlgo::constructInsideModule(), DDHCalEndcapModuleAlgo::constructInsideModule0(), DDHCalEndcapAlgo::constructInsideModule0(), DDHCalBarrelAlgo::constructInsideSector(), DDHCalEndcapAlgo::constructInsideSector(), DDHGCalTBModule::constructLayers(), DDHGCalTBModuleX::constructLayers(), DDAHcalModuleAlgo::constructLayers(), DDHGCalModule::constructLayers(), DDHGCalModuleAlgo::constructLayers(), DDHGCalEEAlgo::constructLayers(), DDHGCalHEAlgo::constructLayers(), DDHGCalHEFileAlgo::constructLayers(), DDHGCalEEFileAlgo::constructLayers(), DDHGCalMixLayer::constructLayers(), DDHGCalSiliconModule::constructLayers(), DDHCalBarrelAlgo::constructMidLayer(), DDHCalEndcapModuleAlgo::constructScintLayer(), DDHCalEndcapAlgo::constructScintLayer(), DDHCalBarrelAlgo::constructSideLayer(), DDHGCalNoTaperEndcap::createQuarter(), DDEcalPreshowerAlgo::doLadders(), DDEcalPreshowerAlgoTB::doLayers(), DDEcalPreshowerAlgo::doLayers(), DDTECModuleAlgo::doPos(), DDEcalPreshowerAlgoTB::doSens(), DDEcalPreshowerAlgo::doSens(), DDEcalPreshowerAlgoTB::doWedges(), DDEcalEndcapAlgo::EECreateSC(), DDEcalEndcapAlgo::EEPositionCRs(), DDTBH4Algo::execute(), DDHGCalCell::execute(), DDHGCalWafer8::execute(), DDTOBRodAlgo::execute(), DDTrackerZPosAlgo::execute(), DDTrackerXYZPosAlgo::execute(), DDEcalAPDAlgo::execute(), DDLinear::execute(), DDTIDModulePosAlgo::execute(), DDTrackerAngular::execute(), DDAngular::execute(), DDTotemAngular::execute(), DDHGCalWaferP::execute(), DDTrackerLinear::execute(), DDTrackerPhiAltAlgo::execute(), DDTrackerPhiAlgo::execute(), DDHGCalWafer::execute(), DDMTDLinear::execute(), DDHCalLinearXY::execute(), DDTIDRingAlgo::execute(), DDHCalTestBeamAlgo::execute(), DDPixFwdDiskAlgo::execute(), DDTOBAxCableAlgo::execute(), DDTECPhiAlgo::execute(), DDTIDAxialCableAlgo::execute(), DDTECOptoHybAlgo::execute(), DDTECPhiAltAlgo::execute(), DDTIDModuleAlgo::execute(), DDTOBRadCableAlgo::execute(), DDDividedGeometryObject::execute(), DDHGCalWaferAlgo::execute(), DDHCalXtalAlgo::execute(), DDHCalAngular::execute(), DDPixPhase1FwdDiskAlgo::execute(), DDHCalTBZposAlgo::execute(), DDMuonAngular::execute(), DDGEMAngular::execute(), DDHGCalWaferF::execute(), DDCutTubsFromPoints::execute(), DDHGCalWaferFullRotated::execute(), DDPixBarLayerUpgradeAlgo::execute(), DDPixBarLayerAlgo::execute(), DDHCalForwardAlgo::execute(), DDTIBLayerAlgo::execute(), DDBHMAngular::execute(), DDTECCoolAlgo::execute(), DDHCalTBCableAlgo::execute(), DDHCalFibreBundle::execute(), DDTECModuleAlgo::execute(), DDEcalBarrelNewAlgo::execute(), DDEcalBarrelAlgo::execute(), DDEcalEndcapAlgo::execute(), DDTrackerIrregularRingAlgo::execute(), DDTrackerRingAlgo::execute(), DDPixFwdBlades::execute(), DDHGCalHEFileAlgo::positionMix(), DDHGCalHEAlgo::positionMix(), DDHGCalMixLayer::positionMix(), DDAHcalModuleAlgo::positionSensitive(), DDHGCalTBModule::positionSensitive(), DDHGCalModuleAlgo::positionSensitive(), DDHGCalEEAlgo::positionSensitive(), DDHGCalModule::positionSensitive(), DDHGCalTBModuleX::positionSensitive(), DDHGCalEEFileAlgo::positionSensitive(), DDHGCalSiliconModule::positionSensitive(), DDHGCalHEAlgo::positionSensitive(), DDHGCalHEFileAlgo::positionSensitive(), DDLPosPart::processElement(), regressionTest_first(), DDEcalBarrelAlgo::web(), and DDEcalBarrelNewAlgo::web().

                                                    {
  int cpno = atoi(copyno.c_str());
  position(self, parent, cpno, trans, rot, div);
}

void DDCompactView::position	(	const DDLogicalPart &	self,
		const DDLogicalPart &	parent,
		int	copyno,
		const DDTranslation &	trans,
		const DDRotation &	rot,
		const DDDivision *	div = nullptr
	)

Definition at line 86 of file DDCompactView.cc.

References rep_.

                                                    {
  rep_->position(self, parent, copyno, trans, rot, div);
}

const DDLogicalPart & DDCompactView::root

(

)

const

returns the DDLogicalPart representing the root of the geometrical hierarchy

Definition at line 63 of file DDCompactView.cc.

References rep_.

Referenced by DDG4Builder::BuildGeometry(), and DDCheckConnect().

{ return rep_->root(); }

void DDCompactView::setRoot

(

const DDLogicalPart &

root

)

Definition at line 96 of file DDCompactView.cc.

References rep_.

Referenced by DDLSAX2ConfigHandler::startElement().

{ rep_->setRoot(root); }

void DDCompactView::swap ( DDCompactView &  repToSwap )

private

Definition at line 98 of file DDCompactView.cc.

References rep_.

{ rep_->swap(*(repToSwap.rep_)); }

const std::vector< double > & DDCompactView::vector

(

std::string_view

iKey

)

const

returns an empty container if not found

Definition at line 67 of file DDCompactView.cc.

References AlCaHLTBitMon_QueryRunRegistry::string, and vectors_.

Referenced by HcalParametersFromDD::build(), TrackerParametersFromDD::build(), MTDParametersFromDD::build(), HGCalGeomParameters::loadCellParsHexagon(), and DDExpandedView::vector().

                                                                        {
  auto itFind = vectors_.find(std::string(iKey));
  if (itFind != vectors_.end()) {
    return itFind->second;
  }
  static const std::vector<double> s_empty;
  return s_empty;
}

DDCompactView::GraphWalker DDCompactView::walker

(

)

const

Definition at line 61 of file DDCompactView.cc.

References rep_.

{ return rep_->walker(); }

const DDPosData * DDCompactView::worldPosition

(

)

const

The absolute position of the world.

Definition at line 65 of file DDCompactView.cc.

References worldpos_.

{ return worldpos_.get(); }

Member Data Documentation

DDI::Store<DDName, std::unique_ptr<DDI::LogicalPart> > DDCompactView::lpStore_

private

Definition at line 138 of file DDCompactView.h.

Referenced by lockdown().

DDI::Store<DDName, std::unique_ptr<DDI::Material> > DDCompactView::matStore_

private

Definition at line 136 of file DDCompactView.h.

Referenced by lockdown().

std::unique_ptr<DDCompactViewImpl> DDCompactView::rep_

private

Definition at line 133 of file DDCompactView.h.

Referenced by DDCompactView(), graph(), position(), root(), setRoot(), swap(), and walker().

DDI::Store<DDName, std::unique_ptr<DDRotationMatrix> > DDCompactView::rotStore_

private

Definition at line 140 of file DDCompactView.h.

Referenced by lockdown().

DDI::Store<DDName, std::unique_ptr<DDI::Solid> > DDCompactView::solidStore_

private

Definition at line 137 of file DDCompactView.h.

Referenced by lockdown().

DDI::Store<DDName, std::unique_ptr<DDI::Specific> > DDCompactView::specStore_

private

Definition at line 139 of file DDCompactView.h.

Referenced by lockdown().

Vectors DDCompactView::vectors_

private

Definition at line 142 of file DDCompactView.h.

Referenced by lockdown(), and vector().

std::unique_ptr<DDPosData> DDCompactView::worldpos_

private

Definition at line 134 of file DDCompactView.h.

Referenced by DDCompactView(), and worldPosition().