---

CdbRevision.hh

Go to the documentation of this file.

#ifndef CDB_REVISION_HH
#define CDB_REVISION_HH

// File and Version Information:
//      $Id: CdbRevision.hh,v 1.4 2002/09/23 22:33:36 gapon Exp $

#include "CdbBase/CdbCPtrBase.hh"
#include "CdbBase/CdbRevisionPtrFwd.hh"
#include "CdbBase/CdbConditionPtrFwd.hh"

#include <string>

class BdbTime;

/// The transient abstract class providing an interface to persistent revisions
/**
  * The objects of concrete subclasses of this class deliver
  * various characteristics of a revision.
  */
class CdbRevision {

friend class CdbCPtrBase< CdbRevision >;    // Who destroys me

private:

  /// The default constructor (NOT IMPLEMENTED)
  /**
    * Is disabled...
    */
    CdbRevision( );

protected:

  /// The normal constructor.
  /**
    * More details...
    */
    CdbRevision( const CdbConditionPtr& thePtr  /**< the back link to the parent object */
               );

  /// The copy constructor
  /**
    * More details...
    */
    CdbRevision( const CdbRevision& theRevision );

  /// The destructor.
  /**
    * More details...
    */
    virtual ~CdbRevision( );

  /// The assignment operator
  /**
    * More details...
    */
    CdbRevision& operator=( const CdbRevision& theRevision );

public:

  /// Return a smart pointer back to the parent object.
  /**
    * @see CdbCondition
    * @see CdbConditionPtr
    */
    const CdbConditionPtr& parent( ) const;

  /// The revision identifier
  /**
    * More info...
    */
    virtual BdbTime id( ) const = 0;

  /// The revision name
  /**
    * More info...
    */
    virtual std::string name( ) const = 0;

  /// The time when this revision was created
  /**
    * Note, that this time can be different from the "timestamp" (the above
    * defined identifier) the revision.
    */
    virtual BdbTime created( ) const = 0;

  /// The revision description
  /**
    * To explain why this revision was created.
    *
    * @return a string with the name
    */
    virtual std::string description( ) const = 0;

private:

    CdbConditionPtr _myParent;
};

#endif  // CDB_REVISION_HH

---