---

CdbBdbSRevisionP.ddl

Go to the documentation of this file.

#ifndef CDBBDBSHARED_REVISION_P_HH
#define CDBBDBSHARED_REVISION_P_HH

// File and Version Information:
//      $Id: CdbBdbSRevisionP.ddl,v 1.6 2004/05/24 18:19:29 gapon Exp $

#include "BdbUtil/Bdb.hh"

#include "CdbBdbShared/CdbBdbSViCollectionP.hh"

/// The persistent incarnation for a revision
/**
  */
class CdbBdbSRevisionP : public BdbPersObj {

public:

  /// Default constructor
  /**
    * It can only be used to construct the "TOPMOST" revisions. The only optional
    * parameter is used when the newely created collection of topmost intervals
    * should be cloned from the specified one. This is the special case.
    *
    * This constructor will also create an empty collection of visible
    * intervals.
    */
    CdbBdbSRevisionP( );

  /// Normal constructor
  /**
    * This constructor is used to construct regular (non-topmost) revisions
    * with specified identification and a collection of visible intervals.
    * The constructor will invoke a "clone" method against the passed collection
    * to make its own copy.
    *
    * The revision identifiers must be meaningfull, which means that the
    * identifier must differ from the "minusInfinity" and "plusInfinity"
    * (this one can be used to identify topmost revisions), and the name must
    * be non-zero pointer.
    *
    * The revision description must be a valid pointer.
    *
    * 
    * Any violation of the above mentioned conditions would cause either
    * deliberate assertion and application crash in the constructor.
    */
    CdbBdbSRevisionP( const BdbTime&                      theId,            /**< The revision identifier */
                      const char*                         theName,          /**< The revision name */
                      const BdbRef(CdbBdbSViCollectionP)& theCollectionRef, /**< The collection of "visible" intervals */
                      const BdbTime&                      theCreationTime,  /**< When this revision is created */
                      const char*                         theDescription    /**< The revision description */
                    );

  // Destructor

    virtual ~CdbBdbSRevisionP( );

  /// Get revision identifier.
  /**
    * This identifier must be equal or greater of the insertion time of any intervals
    * in the revision's collection of 'visible intervals".
    *
    * The returned value may be equal to "plusInfinity" in case if the
    * object was constructed using default constructor ("TOPMOST" revision).
    */
    BdbTime id( ) const;

  /// Get revision name.
  /**
    * This name is guaranteed to be a non-zero string.
    */
    ooString(32) name( ) const;

  /// Get collection of "visible" intervals.
  /**
    */
    BdbRef(CdbBdbSViCollectionP) collection( ) const;

  /// Get revision creation time
  /**
    * This time may differ from the revision identifier if the revision is created
    * "back in time".
    */
    BdbTime created( ) const;

  /// Get revision name.
  /**
    * This name is guaranteed to be a non-zero string.
    */
    ooString(32) description( ) const;

private:

  /// The revision's identifiers.

    BdbTime      _id;
    ooString(32) _name;

  /// The collection of "visible" intervals

    BdbRef(CdbBdbSViCollectionP) _collectionRef;

  // Additional descriptive information

    BdbTime      _created;
    ooString(32) _description;
};

#endif /* CDBBDBSHARED_REVISION_P_HH */

---