---

CdbBdbSOriginP.ddl

Go to the documentation of this file.

#ifndef CDBBDBSHARED_ORIGIN_P_HH
#define CDBBDBSHARED_ORIGIN_P_HH

// File and Version Information:
//      $Id: CdbBdbSOriginP.ddl,v 1.10 2004/08/06 05:54:25 bartoldu Exp $

#include "BdbUtil/Bdb.hh"

#include "BdbTime/BdbTime.hh"

#include "CdbBdbShared/CdbBdbSCollectionElementP.hh"

#include <iostream>

/// Persistent "origin" class
/**
  * Origins represent integral databases of the distributed Condition/DB.
  *
  * NOTE: Origins themselves are not databases, they are just descriptors
  *       of these databases.
  */
class CdbBdbSOriginP : public CdbBdbSCollectionElementP {

public:

  /// The supported origin types

    typedef enum { FIRST  = 0,
                   MASTER = FIRST,
                   SLAVE,
                   REPLICA,        // We leave this item even though it's an obsolete because removin
                                   // this element would affect existing persistent origins (instances
                                   // of the current class).
                   TEST,
                   LAST   = TEST
    } OriginType;

  /// The names of the above defined origin types

    static const char* OriginName[];

  /// Predefined (reserved) origin identifiers (total of 256)

    enum { FIRST_ID  = 0,
           MASTER_ID = FIRST_ID,
           REPLICA_ID,             // We leave this item even though it's an obsolete because removin  
                                   // this element would affect existing persistent origins (instances 
                                   // of the current class).
           TEST_ID,
           LAST_ID   = 255
    };

private:

  /// Default constructor (NOT IMPLEMENTED))
  /**
    * Also see comments about the special constructor defined above.
    */
    CdbBdbSOriginP( );

public:

  /// Normal constructor
  /**
    * WARNING: Inappropriate values of the parameters will cause the crash
    *          of the constructor to avoid creating disformed persistent
    *          data structures.
    */
    CdbBdbSOriginP( const char*    theName,             /**< the name of the origin */
                    d_UShort       theId,               /**< the identifier of the origin */
                    OriginType     theType,             /**< the type from the above defined enumerated type */
                    const BdbTime& theCreationTime,     /**< the time when the origin is supposed to be created */
                    const char*    theDescription,      /**< the description of the origin */
                    const char*    theDbIdRange         /**< the name of the range */
                  );

  /// Destructor
  /**
    */
    virtual ~CdbBdbSOriginP( );

  // Accessors

    OriginType   type       ( ) const;
    BdbTime      created    ( ) const;
    ooString(32) description( ) const;
    ooString(32) dbidrange  ( ) const;

  /// Convert specified name to the type identifier
  /**
    * The passed name must look in the same way as the corressponding value
    * of the enumerated type. For example MASTER corresponds to string "MASTER".
    * This is the case sensitive translation.
    *
    * Return CdbStatus::Success if specified name is valid.
    */
    static CdbStatus name2type( const char* theName,    /**< the name of the type */
                                OriginType& theType     /**< the value to be set up */
                              );

  /// Convert specified type identifier into the name
  /**
    * Will return 0 if specified type does not exist. Will return a pointer
    * onto a static string in case of success.
    */
    static const char* type2name( OriginType  theType   /**< the type identifier */
                                );

  /// Check if specified identifier is a reserved one
  /**
    */
    static bool isReservedId( d_UShort theId            /**< the identifier of the origin */
                            );

  /// Dump the contents of the origin
  /**
    */
    void dump( std::ostream& o ) const;

private:

  // Data members

    OriginType   _type;
    BdbTime      _created;
    ooString(32) _description;
    ooString(32) _dbidrange;
};

#endif /* CDBBDBSHARED_ORIGIN_P_HH */

---