Bdb packages | Design docs | Source docs | Guidelines | Recent releases

Search | Site Map .
Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

CdbViewLocator Class Reference
[CdbBase]

This is a base class for a view locator. More...

#include <CdbViewLocator.hh>

Inheritance diagram for CdbViewLocator:

CdbDatabase CdbBdbSDatabase CdbBdbWDatabase List of all members.

Public Methods

virtual std::string defaultView () const=0
 Default view name.

virtual CdbStatus findView (CdbViewPtr &thePtr, const char *theName=0)=0
 Find the specified view.

virtual CdbStatus findView (CdbViewPtr &thePtr, const CdbId &theId)=0
 Find the specified view.

virtual CdbStatus viewIterator (CdbViewItr &theItr)=0
 Initialize an instance of an iterator for the known views names.


Protected Methods

virtual ~CdbViewLocator ()
 The destructor.

Detailed Description

This is a base class for a view locator.

This is an interface defining a set of methods for view location.

Definition at line 14 of file CdbViewLocator.hh.

Constructor & Destructor Documentation

CdbViewLocator::~CdbViewLocator (    )  [protected, virtual]
 

The destructor.

Is disabled to prevent deleting subclassing objects by a pointer at this interface.

Definition at line 10 of file CdbViewLocator.cc.

Member Function Documentation

virtual std::string CdbViewLocator::defaultView (    )  [pure virtual]
 

Default view name.

This name is delivered when a client is relying on this default.

Implemented in CdbBdbSDatabase, and CdbBdbWDatabase.

virtual CdbStatus CdbViewLocator::findView (  CdbViewPtr &    thePtr,
const CdbId &    theId
)  [pure virtual]
 

Find the specified view.

Unlike the previous method, this one uses "extended" identifier of a view to find the corresponding object.

See also:
CdbId
Parameters:
thePtr  a smart pointer to an object to be initialized
theId  the object specifications

Implemented in CdbBdbSDatabase, and CdbBdbWDatabase.

virtual CdbStatus CdbViewLocator::findView (  CdbViewPtr &    thePtr,
const char *    theName = 0
)  [pure virtual]
 

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 also:
CdbView , CdbViewPtr , CdbStatus
Returns:
a completion status of the operation
Parameters:
thePtr  a smart pointer to an object to be initialized
theName  the object specifications

Implemented in CdbBdbSDatabase, and CdbBdbWDatabase.

virtual CdbStatus CdbViewLocator::viewIterator (  CdbViewItr &    theItr )  [pure virtual]
 

Initialize an instance of an iterator for the known views names.

The iterator will be set into a "valid" state upon successfull completion.

See also:
CdbIItr::isValid() , CdbView , CdbViewItr , CdbStatus
Returns:
completion status

Implemented in CdbBdbSDatabase, and CdbBdbWDatabase.

The documentation for this class was generated from the following files:

 

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

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