---

CdbBdbNTupleFactory.hh

Go to the documentation of this file.

#ifndef CDBBDBTABLE_NTUPLE_FACTORY_HH
#define CDBBDBTABLE_NTUPLE_FACTORY_HH

// File and Version Information:
//      $Id: CdbBdbNTupleFactory.hh,v 1.1 2004/03/24 07:17:07 gapon Exp $

#include "CdbBase/CdbCPtr.hh"

#include "CdbTable/CdbNTuple.hh"

#include "CdbBdb/CdbBdbObjectFactory.hh"

#include "BdbCond/BdbObject.hh"

/// This is a BDB specific implementation for the factory
/**
  * This class is meant to be used to create persistent objects from
  * instances of CdbTable and its derived classes assuming that the default
  * conversion is available for element types of these tuples.
  *
  * TEMPLATE PARAMETERS:
  *
  *   This class has two template parameters defining the type of a transient n-tuple.
  *   Teh parameters are the sdame (and have the same meaning) as in case of
  *   the transient CdbNTuple class.
  *
  *   Here is an example:
  *
  *     CdbCPtr<float,3> tuplePtr = ... ;                   // have a tuple
  *
  *     CdbBdbNTupleFactory<float,3> factory( tuplePtr );   // the factory is ready to be used
  *
  * IMPORTANT USE NOTE:
  *
  *   Remember that the factory will accept and cache a counted smart pointer onto
  *   a tuple. This instance will be used as a source of information later on, at
  *   a time when a CDB API's implementation will be about to store the tuple.
  *   So make sure that you don't change the contents of the transient tuple (pointed
  *   to by the smart reference) between a code creating the factory and a code invoking
  *   CDB API, unless this is done on purpose.
  *
  * @see class CdbBdbObjectFactory
  * @see class CdbTuple
  * @see class CdbBdbNTupleConversion
  */
template< class        T,
          unsigned int NCOL >
class CdbBdbNTupleFactory : public CdbBdbObjectFactory {

private:

  /// The default constructor (NOT IMPLEMENTED)
  /**
    * Is disabled...
    */
    CdbBdbNTupleFactory( );

public:

  /// The destructor.
  /**
    * It's here only to delete classes by a pointer onto this interface.
    */
    virtual ~CdbBdbNTupleFactory( );

  /// The constructor
  /**
    * The value of T type will be passed to the constructor of the corresponding
    * class when the creation will be triggered. It's up to the developer of
    * the persistent class how to treat this situation.
    */
    CdbBdbNTupleFactory( const CdbCPtr< CdbNTuple<T,NCOL> >& thePtr );

protected:

  /// This is a specialized persistent object creation method
  /**
    * This is a default implementation for this creator.
    *
    * @see CdbObjectFactory::create()
    */
    virtual CdbStatus doCreate( BdbHandle(BdbObject)& theProduct,   /**< a reference to a new persistent object to be created */
                                const BdbRefAny&      theHint       /**< a placement hint for new object */
                              );

private:

    CdbCPtr< CdbNTuple<T,NCOL> > _ptr;
};

#ifdef     BABAR_COMP_INST
#include "CdbBdbTable/CdbBdbNTupleFactory.cc"
#endif  // BABAR_COMP_INST

#endif  // CDBBDBTABLE_NTUPLE_FACTORY_HH

---