---

CdbBdbObjectFactory.hh

Go to the documentation of this file.

#ifndef CDBBDB_OBJECT_FACTORY_HH
#define CDBBDB_OBJECT_FACTORY_HH

// File and Version Information:
//      $Id: CdbBdbObjectFactory.hh,v 1.3 2005/09/15 05:06:26 gapon Exp $

#include "CdbBase/CdbObjectFactoryBase.hh"

#include "CdbBase/CdbConditionPtrFwd.hh"
#include "CdbBase/CdbObjectPtrFwd.hh"

#include "BdbCond/BdbObject.hh"

class BdbTime;

/// This is an abstract base class for factories of the CdbObject class
/**
  * The "create" method of the base interface gets its default implementation
  * in here. This implementattion will call a user provided pure virtual
  * method to do the actual object creation. In fact this is a kind of "shell"
  * for the object creation code. This shell will be called with the righ
  * value of the hint.
  *
  * @see CdbObjectFactoryBase
  */
class CdbBdbObjectFactory : public CdbObjectFactoryBase {

public:

  /// The constructor.
  /**
    * The only parameter of the constructor is an optional switch
    * allowing to turn of the verification of the user created object.
    * This may be needed on some special occasions.
    */
    explicit CdbBdbObjectFactory( bool verifyFlag = true );

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

  /// Create a new object for specified validity interval
  /**
    * This is a default implementation for this creator.
    *
    * @see CdbObjectFactoryBase::create()
    */
    virtual CdbStatus create( CdbObjectPtr&          thePtr,            /**< a smart pointer to an object to be created */
                              const CdbConditionPtr& theConditionPtr,   /**< a condition where the new object will be registered at */
                              const BdbTime&         theBegin,          /**< a point where the object's validity begins from */
                              const BdbTime&         theEnd             /**< ... and finishes (exclusing) at */
                            );

protected:

  /// This is a specialized persistent object creation method
  /**
    * This method (to be implemented by developers of specific persistent classes)
    * handles the creation process. This method is parametrized through a "hint"
    * parameter. The product of the operation is delivered into supplied pointer variable
    * passed by reference.
    *
    * This method will indicate the completion status of the operation through
    * its return value of the CdbStatus type. A user can set this variable to communicate
    * with the calling shell in order to indicate if the creation (for some reason)
    * is not possible or failed.
    *
    * @see CdbStatus
    */
    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 */
                              ) = 0;

private:

    bool _verifyFlag;
};

#endif  // CDBBDB_OBJECT_FACTORY_HH

---