Geometry/DTGeometryBuilder/doc/DTGeometryBuilder.doc - master - githubmirror/cmssw

Geometry/DTGeometryBuilder/doc/DTGeometryBuilder.doc

46 строк2 KB

Giulio Eulisse

Snapshot of CMSSW_6_2_0_pre8.

26 июн 2013, 18:12

26 июн 2013, 18:12214ab73

/*!
<!-- Substitute Geometry and DTGeometryBuilder with the proper names! -->

\page Geometry_DTGeometryBuilder Package Geometry/DTGeometryBuilder
<center>
<small>
<a href=http://cmsdoc.cern.ch/swdev/viewcvs/viewcvs.cgi/CMSSW/Geometry/DTGeometryBuilder/?cvsroot=CMSSW&only_with_tag=@CVS_TAG@>Source code (CVS tag: @CVS_TAG@)</a> - 
<a href=http://cmsdoc.cern.ch/swdev/viewcvs/viewcvs.cgi/CMSSW/Geometry/DTGeometryBuilder/.admin/developers?rev=HEAD&cvsroot=CMSSW&content-type=text/vnd.viewcvs-markup>Administrative privileges</a>
</small>
</center>


\section desc Description
<!-- Short description of what this package is supposed to provide -->
Provides the module DTGeometryESModule, which builds the DT geometry model
(cf. \ref Geometry_DTGeometry).

\subsection interface Public interface
<!-- List the classes that are provided for use in other packages (if any) -->
None; this class provides only an EventSetup module.

\subsection modules Modules
<!-- Describe modules implemented in this package and their parameter set -->
- DTGeometryESModule: specified in the configuration with:
\verbatim
es_module = DTGeometryESModule { }
\endverbatim


\subsection tests Unit tests and examples
<!-- Describe cppunit tests and example configuration files -->
- DTGeometryAnalyzer: test module, prints summary information about the DT geometry. Parameter set cards:
\verbatim
module prod =  DTGeometryAnalyzer { }
\endverbatim
- testDTGeometry.cfg: example of parameters to create the DT geometry and run 
DTGeometryAnalyzer

\section status Status and planned development
<!-- e.g. completed, stable, missing features -->
Completed.

<hr>
Last updated: @DATE@
Author: N. Amapane
*/