Bdb packages | Design docs | Source docs | Guidelines | Recent releases
	Search | Site Map .

                 

---

/CdbBdbShared/CdbBdbSView.hh

Go to the documentation of this file.

#ifndef CDBBDBSHARED_VIEW_HH
#define CDBBDBSHARED_VIEW_HH

#include "CdbBase/CdbView.hh"
#include "CdbBdbShared/CdbBdbSViewP.hh"
#include "CdbBdbShared/CdbBdbSRegistryP.hh"

/// This class implements an abstract base class CdbView
/**
  * This class is based on new implementation of persistent data structures.
  *
  * @see CdbView
  */
class CdbBdbSView : public CdbView {

private:

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

  /// The copy constructor (NOT IMPLEMENTED)
  /**
    * Is disabled...
    */
    CdbBdbSView( const CdbBdbSView& theView );

  /// The assignment operator (NOT IMPLEMENTED)
  /**
    * Is disabled...
    */
    CdbBdbSView& operator=( const CdbBdbSView& theView );

protected:

  /// The cloning method
  /**
    * Implements the corresponding method of a base class or interface.
    *
    * @see CdbCloneable::clone()
    */
    virtual CdbView* clone( ) const;

public:

  /// The normal constructor...
  /**
    * More details...
    */
    CdbBdbSView( const CdbDatabasePtr&              thePtr,             /**< the smart pointer providing a back link to the parent object */
                 const char*                        theName,            /**< the name of the view */
                 const CdbId&                       theId,              /**< extended identifier of the view */
                 const BdbHandle(CdbBdbSViewP)&     theViewH,           /**< the persistent representation of this view */
                 const BdbHandle(CdbBdbSRegistryP)& theMasterRegistryH, /**< the main access point to the persistent store */
                 const BdbHandle(CdbBdbSRegistryP)& theLocalRegistryH   /**< the main access point to the persistent store */
               );

  /// The destructor.
  /**
    * Is only available for the derived classes and friends to prevent accidental
    * deletion of objects.
    */
    virtual ~CdbBdbSView( );

public:

  /// Check if the current API context is valid.
  /**
    * Implements a pure virtual method of a base class or interface.
    *
    * @see CdbStateControl::isValid()
    */
    virtual bool isValid( );

  /// Check if the current API component is open.
  /**
    * Implements a pure virtual method of a base class or interface.
    *
    * @see CdbStateControl::isOpen()
    */
    virtual bool isOpen( );

  /// Open the component.
  /**
    * Implements a pure virtual method of a base class or interface.
    *
    * @see CdbStateControl::open()
    */
    virtual CdbStatus open( );

  /// Close the component.
  /**
    * Implements a pure virtual method of a base class or interface.
    *
    * @see CdbStateControl::close()
    */
    virtual CdbStatus close( );

  /// Get the current status of the view
  /**
    * Implements a pure virtual method of a base class or interface.
    *
    * @see CdbStateControl::isFrozen()
    */
    virtual bool isFrozen( ) const;

  /// Find the specified Folder
  /**
    * Implements a pure virtual method of a base class or interface.
    *
    * @see CdbFolderLocator::findFolder()
    */
    virtual CdbStatus findFolder( CdbFolderPtr& thePtr,
                                  const char*   theName );

  /// Initialize an instance of an iterator for the known folders names
  /**
    * Implements a pure virtual method of a base class or interface.
    *
    * @see CdbFolderLocator::folderIterator()
    */
    virtual CdbStatus folderIterator( CdbFolderItr& theItr );

  /// Get a "config element" for a condition at specified point of validity time
  /**
    * Implements a pure virtual method of a base class or interface.
    *
    * @see CdbView::get()
    */
    virtual CdbStatus get( const char*       theName,
                           const BdbTime&    theValidityTime,
                           CdbConfigElement& theConfigElement
                         ) const;

  /// Set up an iterator of "config elements" for a condition
  /**
    * Implements a pure virtual method of a base class or interface.
    *
    * @see CdbView::configIterator()
    */
    virtual CdbStatus configIterator( const char*               theName,
                                      CdbItr<CdbConfigElement>& theItr ) const;

  /// Get current value of the state identifier
  /**
   * Implements a pure virtual method of a base class or interface.
   *
   * @see CdbView::currentStateId()
   */
    virtual CdbStateId currentStateId( const BdbTime& theValidityTime ) const;

  /// Initialize an instance of an iterator for the history events
  /**
    * Implements a pure virtual method of a base class or interface.
    *
    * @see CdbHistoryProvider::historyEventIterator()
    */
    virtual CdbStatus historyEventIterator( CdbHistoryEventItr& theItr,
                                            const BdbTime&      theBeginTime,
                                            const BdbTime&      theEndTime,
                                            const char**        theEventsToSelect );

  /// Initialize an instance of an iterator for the khistory events
  /**
    * Implements a pure virtual method of a base class or interface.
    *
    * @see CdbHistoryProvider::historyEventTypeIterator()
    */
    virtual CdbStatus historyEventTypeIterator( CdbHistoryEventTypeItr& theItr );

private:

  // Access points to the persistent store

    BdbHandle(CdbBdbSViewP)     _viewH;
    BdbHandle(CdbBdbSRegistryP) _masterRegistryH;
    BdbHandle(CdbBdbSRegistryP) _localRegistryH;
};

#endif  // CDBBDBSHARED_VIEW_HH

 

---

BaBar Public Site | SLAC | News | Links | Who's Who | Contact Us

Page Owner: Jacek Becla
Last Update: October 04, 2002