BOSS 7.0.5
BESIII Offline Software System
Loading...
Searching...
No Matches
Calibration/calibUtil/calibUtil-00-00-43/src/mainpage.h
Go to the documentation of this file.
1// Mainpage for doxygen
2
3/** @mainpage package calibUtil
4
5 @authors J. Bogart, M. Gulati
6
7 @section intro Introduction
8 This package contains (well, will contain) utilities for storing,
9 searching for, and accessing calibration data. "Calibration data"
10 include at a minimum hardware status information, such as hot and
11 dead tracker strips, and conversion constants, such as those
12 characterizing light attenuation in calorimeter crystals.
13
14 The overall strategy is to store a limited amount of <b>metadata</b>
15 about each set of calibration data in a relational database table,
16 while the data are kept in flat files, one per result set. Most
17 likely two formats will be supported for these files: XML and ROOT.
18 See the <a href="http://www.slac.stanford.edu/exp/glast/ground/software/calibration/CalibSvcSpec.shtml">Calibration Services Specification</a> document
19 for more details.
20
21 The classes in this package, all in the calibUtil namespace, include
22
23 <dl>
24 <dt>Metadata</dt>
25 <dd>Provides services to read and write metadata. All access to the
26 rdbms (currently MySQL) is encapsulated here.</dd>
27 <dt>StripSrv</dt>
28 <dd>Reads in bad (tracker) strip data from its persistent form (currently
29 XML) and makes it available to clients via query services and
30 a visitor serice, traverseInfo. </dd>
31 <dt>ClientObject</dt>
32 <dd>This pure virtual class is used by the StripSrv visitor. Clients
33 must implement their own derived class.</dd>
34 <dt>GenericSrv</dt>
35 <dd>Handles generic part of calibration data set; that is, that part
36 which is common to all types of calibration. This is an internal
37 calibUtil class not directly accessible by calibUtil clients.</dd>
38 <dt>Timestamp</dt>
39 <dd>Encapsulation of timestamp (resolution of a second) as used within
40 calibUtil.</dd>
41 </dl>
42
43
44 <hr>
45 @section notes release.notes
46 release.notes
47 <hr>
48 @section requirements requirements
49 @verbinclude requirements
50 <hr>
51 @todo
52 Finish Metadata searching services
53
54 @todo
55 Add write services to StripSrv
56
57 @todo
58 Make analagous class(es) for handling ROOT persistent form
59
60 */
61