Back to home page

EIC code displayed by LXR

 
 

    


Warning, /DD4hep/etc/Detector_constructor_naming_convention.txt is written in an unsupported language. File is not indexed.

0001 
0002 Proposal for detector constructor names
0003 =======================================
0004 
0005 Detector constructors are identified by a unique name. This name is 
0006 identical to the name of the creating factory object.
0007 This small writeup is a proposal to properly name these factory 
0008 methods in order to avoid nameing clashes.
0009 
0010 
0011 - Experiment specific detector constructors names have the 
0012   experiment name as a namespace prefix
0013   examples: CLIC_<detector>, ILD_<detector>, etc.
0014 - Experiment specific detector constructors reside in 
0015   experiment specific packages such as ddsim (for ILD).
0016 
0017 
0018 - Generic DD4hep detectors will have the prefix DD4hep_
0019 
0020 __or__   (to be discussed)
0021 
0022 - Generic DD4hep detectors will have no prefix
0023 - Generic DD4hep detector constructors reside in the package DDDetectors
0024   (to be created)
0025 
0026 
0027 In case a experiment specific detector constructor is sufficiently 
0028 generic that it could be applied in several detector designs and 
0029 hence the visiblility should be upgraded, the detector constructor 
0030 may be imported to DDDetectors.
0031 
0032 - Consequently the detector constructor prefix has to change.
0033 - For some time (e.g. 1 year) the old factory may still be 
0034   supported along with some ugly deprecation printout.
0035 
0036