MagneticField/UniformEngine/doc/UniformEngine.doc - master - githubmirror/cmssw

MagneticField/UniformEngine/doc/UniformEngine.doc

47 строк2 KB

Giulio Eulisse

Snapshot of CMSSW_6_2_0_pre8.

26 июн 2013, 18:12

26 июн 2013, 18:12214ab73


/*!

\page MagneticField_UniformEngine Package MagneticField/UniformEngine

<center>
<small>

<!-- @CVS_TAG@ will be substituted at build time, no need to touch -->
<a href=http://cmsdoc.cern.ch/swdev/viewcvs/viewcvs.cgi/CMSSW/MagneticField/UniformEngine/?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/MagneticField/UniformEngine/.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 -->

Simple field engine providing a constant programmable magnetic field.

\subsection interface Public interface
<!-- List the classes that are provided for use in other packages (if any) -->
No class is directly exposed to the user: field engines are accessed via the MagneticField interface.

\subsection modules Modules
<!-- Describe modules implemented in this package and their parameter set -->

- UniformMagneticFieldESProducer.

To use this engine you should include in the cfi:

<pre>
include "MagneticField/Engine/data/uniformMagneticField.cfi"
</pre>


\subsection tests Unit tests and examples
<!-- Describe cppunit tests and example configuration files -->
An example of field access is provided in MagneticField/Engine/test/testMagneticField.cfg.


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

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