GETDocConfig.hh

Go to the documentation of this file.

//======================================================================
/*! \file GETDocConfig.hh
 *
 *  Documentation page related to the use of configuration files.
 */
//======================================================================

//======================================================================
/*! \page get_page_config GET configuration files
 *
 *  THE PROCESSING OF CONFIGURATION FILE IS UNDER DEVELOPMENT !!!
 *
 *  The core classes to process GET data define a pointer to the
 *  configuration classes, that contain the information that can be read
 *  from the GET system configuration files (XML format).
 *
 *  The configuration classes only contain partial information, depending
 *  on the analysis needs (this is subject to evolution).
 *
 *  For data that can be defined from a set of fixed values (such as
 *  AGet peaking time), the information is stored as an unsigned integer
 *  value, corresponding to the data.
 *  In such case, an enumeration is defined in the class itself.
 *
 *  If necessary, the configuration class defines a conversion function,
 *  to get physical value corresponding to the data.
 *
 *  The reading of configuration files uses the Document Object Model (DOM)
 *  tree structure from the Xerces-c library.
 *  The configuration data are set from DOM tree nodes with the functions
 *  defined in the GETCfgTools.hh file (see GETCfgSetData and GETCfgSetLogic).
 *
 *
 *  \section get_config_creation Creating configuration associated to the core objects
 *
 *  The top object of the GET library is defined by the GETSystem class,
 *  which holds all the children objects (CoBo, AsAd...).
 *
 *  The configuration objects should only be created \b after the system
 *  architecture is fully defined (see example \ref ReadConfig.cxx)
 *  and initialized (the initialization may be performed when
 *  the system is created, if it is fully defined).
 *
 *
 *  \section get_config_properties Updating core objects properties from configuration
 *
 *  NOT IMPLEMENTED
 *
 */
//======================================================================