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

                 

---

/BdbObjyMgmt/BdbObjyDomainSet.hh

Go to the documentation of this file.

#if !defined(BDBOBJYDOMAINSET_HH)
#define BDBOBJYDOMAINSET_HH
//--------------------------------------------------------------------------
// File and Version Information:
//      $Id: BdbObjyDomainSet.hh,v 1.1 2001/06/21 21:53:34 patton Exp $
//
// Description:
//      Class BdbObjyDomainSet:
//
// Environment:
//      Software developed for the BaBar Detector at the SLAC B-Factory.
//
// Author List:
//      Simon Patton
//
// Copyright Information:
//      Copyright (C) 1999      LBNL
//
//------------------------------------------------------------------------

//-------------
// C Headers --
//-------------
extern "C" {
#include <sys/types.h>
}

//---------------
// C++ Headers --
//---------------

//-----------------
// BaBar Headers --
//-----------------
#include "BaBar/BaBar.hh"

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

//------------------------------------
// Collaborating Class Declarations --
//------------------------------------
class BdbObjyDomain ;

//----------------------
// Base Class Headers --
//----------------------

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

/**
  * The BdbObjyDomainSet class is ...
  */
class BdbObjyDomainSet
{
   public:

      // Typedefs, consts, and enums

      typedef BdbObjyDomain** iterator ;
      typedef BdbObjyDomain*const* const_iterator ;

      /**
       * Constructs an instanace of this class.
       */
      BdbObjyDomainSet( size_t initialLength ) ;

      /**
       * Destroys this instance.
       */
      virtual ~BdbObjyDomainSet() ;

      // Selectors (const)

      /**
       * @return iterator to first element in set
       */
      const_iterator begin() const ;

      /**
       * @return iterator to one-past-the-end element in set
       */
      const_iterator end() const ;

      /**
       * @return true if set is empty
       */
      bool empty() const ;

      // Modifiers

      /**
       * Add specified BdbObjyDomain into set
       */
      void insert( BdbObjyDomain* domain ) ;

      /**
       * @return true if specified BdbObjyDomain is removed from set
       */
      bool remove( BdbObjyDomain* domain ) ;

   protected:

      // Selectors (const)

      /**
       * @return true if specified domain is in the set
       */
      bool contains( BdbObjyDomain* domain ) const ;

      // Modifiers

      /**
       * @return iterator to first element in set
       */
      iterator begin() ;

      /**
       * @return iterator to one-past-the-end element in set
       */
      iterator end() ;

   private:

      // Constructors
      /** stops default */
      BdbObjyDomainSet( const BdbObjyDomainSet& aRhs ) ;

      // Operators
      /** stops default */
      const BdbObjyDomainSet& operator=( const BdbObjyDomainSet& aRhs ) ;

      // Data Members

      /** Stack of BdbObjyDomains */
      BdbObjyDomain** _set ;
      /** number of entries in actiation stack */
      size_t _depth ;
      /** current limit on number of entries in actiation stack */
      size_t _length ;
} ;

// inline function definitions

#endif // BDBOBJYDOMAINSET_HH

 

---

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

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