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

                 

---

/BdbDomainMgmt/BdbDomainName.hh

Go to the documentation of this file.

#if !defined(BDBDOMAINNAME_HH)
#define BDBDOMAINNAME_HH
//--------------------------------------------------------------------------
// File and Version Information:
//      $Id: BdbDomainName.hh,v 1.1 2001/06/21 21:50:20 patton Exp $
//
// Description:
//      Class BdbDomainName:
//
// Environment:
//      Software developed for the BaBar Detector at the SLAC B-Factory.
//
// Author List:
//      Simon Patton            Stripped from origianl BdbDomain code
//
// Copyright Information:
//      Copyright (C) 1999      LBNL
//
//------------------------------------------------------------------------

//-------------
// C Headers --
//-------------
extern "C" {
           }

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

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

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

//------------------------------------
// Collaborating Class Declarations --
//------------------------------------

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

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

/**
  * The BdbDomainName class is ...
  */
class BdbDomainName
{
      // friend classes and functions

   public:

      // Typedefs, consts, and enums

      /**
       ** Domains
       **/
      enum Domains { FirstDomain=0 ,
                     Conditions=FirstDomain ,
                     Events ,
                     Spatial , 
                     Temporal ,
                     Configuration ,
                     Ambient ,
                     IllegalDomain } ;

      // Constructors and destructor

      /**
        * Constructs an instanace of this class.
        */
      BdbDomainName( Domains domain ) ;

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

      // Selectors (const)

      /**
       ** The current domain
       **/
      Domains domain( ) const;

      /**
       ** The name of the current domain
       **/
      const char* domainName( ) const;

      /**
       ** Short name of the current domain
       **/
      const char* shortDomainName( ) const;

      // Modifiers

      // Static Member Functions

      /**
       ** Determine whether the specified domain is valid
       **/
      static bool isDomainValid   ( Domains    theDomain );

      /**
       ** Determine whether the specified domain name is valid
       **/
      static bool isDomainValid( const char* domainName );

      /**
       ** The unique index corresponding to the specified domain name
       **/
      static Domains domainNr(const char* domainName) ;

      /**
       ** The name corresponding to the specified domain
       **/
      static const char* domainName( Domains theDomain );

      /**
       ** Converts short domain name to full domain name
       **/
      static const char* domainName(const char* shortDomainName);

      /**
       ** The shortened form (3 characters) of the specified domain name
       **/
      static const char* shortDomainName( Domains theDomain );

      /**
       ** The shortened form (3 characters) of the specified domain name
       **/
      static const char* shortDomainName(const char* fullDomainName) ;

   protected:

      // Selectors (const)

      // Modifiers

   private:

      // Constructors
      /** stops default */
      BdbDomainName() ;

      /** stops default */
      BdbDomainName( const BdbDomainName& aRhs ) ;

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

      // Selectors (const)

      // Modifiers

      // Static Member Functions

      // Data Members

      Domains    _domain;

      // Static Data Members

   public:
      /** names of each possible Domain */
      static const char* DomainNames   [];
      /** short form of names for each possible domain */
      static const char* ShortDomainNames[];
} ;

// inline function definitions

#endif // BDBDOMAINNAME_HH

 

---

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

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