Warning, /MagneticField/UniformEngine/doc/UniformEngine.doc is written in an unsupported language. File is not indexed.
0001
0002 /*!
0003
0004 \page MagneticField_UniformEngine Package MagneticField/UniformEngine
0005
0006 <center>
0007 <small>
0008
0009 <!-- @CVS_TAG@ will be substituted at build time, no need to touch -->
0010 <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> -
0011 <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>
0012 </small>
0013 </center>
0014
0015 \section desc Description
0016 <!-- Short description of what this package is supposed to provide -->
0017
0018 Simple field engine providing a constant programmable magnetic field.
0019
0020 \subsection interface Public interface
0021 <!-- List the classes that are provided for use in other packages (if any) -->
0022 No class is directly exposed to the user: field engines are accessed via the MagneticField interface.
0023
0024 \subsection modules Modules
0025 <!-- Describe modules implemented in this package and their parameter set -->
0026
0027 - UniformMagneticFieldESProducer.
0028
0029 To use this engine you should include in the cfi:
0030
0031 <pre>
0032 include "MagneticField/Engine/data/uniformMagneticField.cfi"
0033 </pre>
0034
0035
0036 \subsection tests Unit tests and examples
0037 <!-- Describe cppunit tests and example configuration files -->
0038 An example of field access is provided in MagneticField/Engine/test/testMagneticField.cfg.
0039
0040
0041 \section status Status and planned development
0042 <!-- e.g. completed, stable, missing features -->
0043 Completed.
0044
0045 <hr>
0046 Last updated:
0047 @DATE@ Author: N. Amapane (CERN)
0048 */
0049
