---

CdbBdbInit.hh

Go to the documentation of this file.

#ifndef CDBBDBINIT_HH
#define CDBBDBINIT_HH

//--------------------------------------------------------------------------
// File and Version Information:
//      $Id: CdbBdbInit.hh,v 1.6 2005/10/25 19:36:51 gapon Exp $
//
// Description:
//      Class CdbBdbInit.  Initialize Cdb.
//
// Environment:
//      Software developed for the BaBar Detector at the SLAC B-Factory.
//
// Author List:
//     David Brown, Igor Gaponenko 4/26/02
//
// Copyright Information:
//      Copyright (C) 2002              Lawrence Berkeley Laboratory
//
//------------------------------------------------------------------------

//----------------------
// Base Class Headers --
//----------------------
#include "Framework/AppModule.hh"
#include "Framework/AbsParmString.hh"
#include "Framework/AbsParmDouble.hh"
#include "Framework/AbsParmGeneral.hh"
#include "AbsParm/AbsParmNamedValue.hh"

//-----------------
// Other headers --
//-----------------
#include "BdbTime/BdbTime.hh"

class CdbBdbInit : public AppModule {

private:

  // the selection of CDB implementations
  enum Implementation { AUTODETECTION = 0,
                        WRAPPER,
                        SHARED };

  /// Main transaction policy
  /**
   *  RESTARTED_LONG_MAIN_TRANSACTION : same as LONG_MAIN_TRANSACTION but restarted every 'N' seconds, where
   *                                    is defined by the value of the "MainTransactionRestartInterval".
   *                                    The default value of thsi parameter is implementation specific. See
   *                                    the body of the class for details.
   *            LONG_MAIN_TRANSACTION : begin transaction at ::beginJob(), commit it at ::endJob()
   *           SHORT_MAIN_TRANSACTION : begin transaction at ::beginJob(), commit it at the second invocation of ::event()
   *              NO_MAIN_TRANSACTION : do no start main transaction at all.
   */
  enum MainTransactionPolicy { RESTARTED_LONG_MAIN_TRANSACTION = 0,
                                         LONG_MAIN_TRANSACTION,
                                        SHORT_MAIN_TRANSACTION,
                                           NO_MAIN_TRANSACTION };

public:

  // Constructors
  CdbBdbInit( const char* const theName        = "CdbBdbInit",
              const char* const theDescription = "Initialize Conditions database access" );

  // Destructor
  virtual ~CdbBdbInit( );

  // Operations
  virtual AppResult beginJob( AbsEvent* anEvent );
  virtual AppResult    event( AbsEvent* anEvent );
  virtual AppResult   endJob( AbsEvent* anEvent );

private:

  void  startTransaction( );
  void commitTransaction( );

private:

  // Parameters of the module

  AbsParmNamedValue<Implementation>        _implementation;
  AbsParmString                            _view;
  AbsParmString                            _truncateTime;
  AbsParmNamedValue<MainTransactionPolicy> _mainTransactionPolicy;
  AbsParmDouble                            _mainTransactionRestartInterval;
  AbsParmGeneral<unsigned>                 _cacheMaxPages;

  // The context of the module

  unsigned int _numEvents;  // number of times the ::event() method got called

  BdbTime _previousTimestamp;  // the last time the ::event() method was invoked.

  // Parameter:
  //
  //   "AllowedOrigins"
  //
  // Description:
  //
  //   This parameter can be used to prevent an application from running against
  //   any type of CDB installations (so called "origins") not mentioned in this
  //   parameter.
  //
  // Syntax:
  //
  //   A comma separated list of allowed origins is expected here. A variable number
  //   of origins is allowed. Duplications of origins is also allowed, this however
  //   will be treated as one entry of that origin. Any kinds of
  //   spaces/tabs/newlines are not allowed in the string.
  //
  //   The general syntax is:
  //
  //     * | <name1>[,<name2>[...]]
  //
  //   Where:
  //
  //     <name1>, <name2> are the names of the origins. Use the corresponding CDB
  //                      management tools to get a list of known ones.
  //
  //   Note, that the '*' character used above is the legal value of the parameter
  //   recognized by the module.
  //
  // Examples:
  //
  //   *
  //   NAME
  //   NAME1,NAME2
  //
  // Default value:
  //
  //   The default value for the parameter is "*" meaning that there is no restrictions
  //   on where to run this module.
  //

  AbsParmString _allowedOrigins;
};

#endif

---