Warning, /CondFormats/SiStripObjects/doc/SiStripObjects.doc is written in an unsupported language. File is not indexed.
0001
0002 /*!
0003
0004 \page CondFormats_SiStripObjects Package CondFormats/SiStripObjects
0005
0006 <center>
0007 <small>
0008
0009 <!-- @PROJ_VERS@ will be substituted at build time, no need to touch -->
0010 <a href=http://cmsdoc.cern.ch/swdev/viewcvs/viewcvs.cgi/CMSSW/CondFormats/SiStripObjects/?cvsroot=CMSSW&only_with_tag=@PROJ_VERS@>CVS</a> -
0011 <a href=http://cmsdoc.cern.ch/swdev/viewcvs/viewcvs.cgi/CMSSW/CondFormats/SiStripObjects/.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 This package provides the classes that define the conditions objects
0019 available via the EventSetup interface, such as the readout cabling
0020 connections (SiStripFedCabling) for the strip tracker.
0021
0022 \subsection interface Public interface
0023 <!-- List the classes that are provided for use in other packages (if any) -->
0024
0025 FedChannelConnection A container class which defines a single FED
0026 channel connection, as well as holding information related to the
0027 position of the connected device(s) within the strip tracker control
0028 system.
0029 NOTA BENE: the FedChannelConnection class is frequently used
0030 as a data type in method argument lists and as a return type, as it is
0031 an easy way to move hardware identifiers/addresses (eg, FEC crate slot
0032 and ring, CCU address and channel, etc...) and connection information
0033 around.
0034
0035 SiStripControlCabling (Will be deprecated soon.)
0036
0037 SiStripFedCabling Defines the readout cabling connections, ie, which
0038 front-end modules (or more precisely, which pairs of APV25 chips) are
0039 connected to which FED channels, as well as providing information on
0040 the position of the connected device(s) within the control system. The
0041 SiStripFedCabling class handles the "fundamental" FedChannelConnection
0042 objects that represent a single FED channel "connection".
0043 The SiStripFedCabling class represents the "FED" (or "readout") view
0044 of the detector. Alternative views are the "FEC" (equivalent to
0045 "control") and "DET" (equivalent to "geometrical") views, as defined
0046 by classes in CalibFormats/SiStripObjects).
0047
0048 SiStripNoises (Notes to come.)
0049 SiStripPedestals (Notes to come.)
0050 SiStripReadoutCabling (Will be deprecated soon.)
0051
0052 \subsection modules Modules
0053 <!-- Describe modules implemented in this package and their parameter set -->
0054
0055 No plug-in modules.
0056
0057 \subsection tests Unit tests and examples
0058 <!-- Describe cppunit tests and example configuration files -->
0059
0060 None.
0061
0062 \section status Status and planned development
0063 <!-- e.g. completed, stable, missing features -->
0064
0065 FED cabling classes are essentially complete and stable.
0066 Pedestals and noise classes are under developments.
0067 More calibration objects to be defined.
0068
0069 <hr>
0070 Last updated:
0071 @DATE@ Author: computer-generated.
0072 */
0073