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

                 

---

/BdbCondRemote/BdbCondRCacheNode.hh

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//
// File and Version Information:
//      $Id: BdbCondRCacheNode.hh,v 1.3 2002/06/21 18:49:54 ryd Exp $
//
// Description:
//      This class provides a basic functionality for the node in
//      a heterogenious cache tree.
//      The nodes are able to store the pointers to objects of a user
//      defined class. These objects are given unique keys, represented
//      as RW strings.
//
//      The instances of this class could not be constructed on its own.
//      They must always be used as a base for the actual nodes.
//
//      The methods of this class are defined as "virtual" in order
//      to be able to extend their functionality when it's needed.
//
// Environment:
//      Software developed for the BaBar Detector at the SLAC B-Factory.
//
// Author List:
//      Igor A. Gaponenko       Original Author
//
// Copyright Information:
//      Copyright (C) 2000      Lawrence Berkeley Laboratory
//
//-----------------------------------------------------------------------------

#ifndef BDBCONDRCACHENODE_HH
#define BDBCONDRCACHENODE_HH

// -------------------
// -- BaBar Headers --
// -------------------

#include "BaBar/BaBar.hh"

//-------------------------------
// Collaborating Class Headers --
//-------------------------------

#include <string>
#include <vector>
#include <map>

// ---------------------
// -- Class Interface --
// ---------------------

template < class Object >
class BdbCondRCacheNode {

// The ctors, dtor and asignment operator
// are only allowed for the subclasses.

protected:

  // Constructor(s).

    BdbCondRCacheNode( );

    BdbCondRCacheNode( const BdbCondRCacheNode<Object>& theNode );

  // Destructor

    virtual ~BdbCondRCacheNode( );

  // Operators

    BdbCondRCacheNode& operator=( const BdbCondRCacheNode<Object>& theNode );

public:

  // Operations

  /** Get a list of keys for the object pointers in the cache.
   **
   ** The list is always cleared before to search the cache contents.
   **/
    virtual void keys( std::vector<std::string>& theList );

  /** Find a pointer to the object corresponding to the specified key.
   **
   ** Return null pointer if the key was not found.
   **/
    virtual Object* find( const char* theKey );

  /** Add a next object pointer associated with specified key.
   **
   ** Replace the object pointer and return the previous pointer if there
   ** object pointer with the same key and if its pointer is different.
   **
   ** Return null pointer if the key was not known before.
   **/
    virtual Object* add( const char* theKey,
                         Object*     theObjectPtr );

  /** Remove the object pointer associated with specified key from the cache.
   **
   ** This is  the "deep" operation - it will also invoke the destructor of
   ** the corresponding object (if any) following its pointer.
   **/
    virtual void remove( const char* theKey );

  /** Remove all object pointers from the cache.
   **
   ** This will also invoke the destructors for the corresponding objects
   ** following their pointers.
   **/
    virtual void clear( );

private:

  // Helpers

  /** Invoke the destructors for all the objects whose pointers
   ** are stored in the cache. Then clear the cache itself.
   **/
    void deleteObjects( );

private:

  // The cache itself.

  std::map<std::string, Object*>* _cache;
};

#ifdef    BABAR_COMP_INST
#include  "BdbCondRemote/BdbCondRCacheNode.cc"
#endif  /* BABAR_COMP_INST */

#endif /* BDBCONDRCACHENODE_HH */

 

---

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

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