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

                 

---

/CdbBase/CdbViewLocator.hh

Go to the documentation of this file.

#ifndef CDB_VIEW_LOCATOR_HH
#define CDB_VIEW_LOCATOR_HH

#include "CdbBase/CdbId.hh"
#include "CdbBase/CdbViewPtrFwd.hh"
#include "CdbBase/CdbViewItr.hh"

#include <string>

/// This is a base class for a view locator
/**
  * This is an interface defining a set of methods for view location.
  */
class CdbViewLocator {

protected:

  /// The destructor
  /**
    * Is disabled to prevent deleting subclassing objects by a pointer
    * at this interface.
    */
    virtual ~CdbViewLocator( );

public:

  /// Default view name
  /**
    * This name is delivered when a client is relying on this default.
    */
    virtual std::string defaultView( ) const = 0;

  /// Find the specified view
  /**
    * This method initializes a smart pointer to a transient object
    * of the CdbView class representing the found view. It will initialize
    * the smart pointer to point onto 0 and return the corresponding error status
    * when specified object is not found or is not awailable for some
    * other reason.
    *
    * The only parameter to be specified when looking for a view is its name. If
    * a 0 pointer is passed instead of the name then a default view will be open.
    *
    * @see CdbView
    * @see CdbViewPtr
    * @see CdbStatus
    *
    * @return a completion status of the operation
    */
    virtual CdbStatus findView( CdbViewPtr& thePtr,         /**< a smart pointer to an object to be initialized */
                                const char* theName = 0     /**< the object specifications */
                              ) = 0;

  /// Find the specified view
  /**
    * Unlike the previous method, this one uses "extended" identifier of a view
    * to find the corresponding object.
    *
    * @see CdbId
    */
    virtual CdbStatus findView( CdbViewPtr&  thePtr,        /**< a smart pointer to an object to be initialized */
                                const CdbId& theId          /**< the object specifications */
                              ) = 0;

  /// Initialize an instance of an iterator for the known views names
  /**
    * The iterator will be set into a "valid" state upon successfull completion.
    *
    * @see CdbIItr::isValid()
    * @see CdbView
    * @see CdbViewItr
    * @see CdbStatus
    *
    * @return completion status
    */
    virtual CdbStatus viewIterator( CdbViewItr& theItr ) = 0;
};

#endif  // CDB_VIEW_LOCATOR_HH

 

---

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

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