---

CdbRooRoRevisionR.rdl

Go to the documentation of this file.

#ifndef CDBROOREADONLY_REVISION_R_RDL
#define CDBROOREADONLY_REVISION_R_RDL

// File and Version Information:
//      $Id: CdbRooRoRevisionR.rdl,v 1.3 2005/06/23 23:44:47 gapon Exp $

#include "CdbRooReadonly/CdbRooRoTimeR.hh"
#include "CdbRooReadonly/CdbRooRoViCollectionR.hh"

#include <string>

/// The persistent incarnation for a revision
/**
  */
class CdbRooRoRevisionR {

public:

  /// Default constructor
  /**
    * Is required by the ROOT I/O streamers.
    */
    CdbRooRoRevisionR( );

  /// Normal constructor

    CdbRooRoRevisionR( const BdbTime&               theId,              /**< The revision identifier */
                       const char*                  theName,            /**< The revision name */
                       const CdbRooRoViCollectionR& theCollection,      /**< The collection of "visible" intervals */
                       const BdbTime&               theCreationTime,    /**< When this revision is created */
                       const char*                  theDescription      /**< The revision description */
                     );

  /// Normal constructor
  /**
    * This form of the constructor doesn't take any collection of visible intervals.
    */
    CdbRooRoRevisionR( const BdbTime& theId,              /**< The revision identifier */
                       const char*    theName,            /**< The revision name */
                       const BdbTime& theCreationTime,    /**< When this revision is created */
                       const char*    theDescription      /**< The revision description */
                     );

  // Destructor

    virtual ~CdbRooRoRevisionR( ) { }

  /// 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 { return _id.getBdbTime( ); }

  /// Get revision name.
  /**
    * This name is guaranteed to be a non-zero string.
    */
    const std::string& name( ) const { return _name; }

  /// Get collection of "visible" intervals.
  /**
    * NOTE: The non-const reference to a collection is returned. It can also be used to modify
    *       the collection.
    */
    CdbRooRoViCollectionR& collection( ) { return _intervals; }

  /// Get collection of "visible" intervals (const reference)

    const CdbRooRoViCollectionR& collection( ) const { return _intervals; }

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

  /// Get revision name.

    const std::string& description( ) const { return _description; }

    void dump( std::ostream& o ) const;

private:

  /// The revision's identifiers.

    CdbRooRoTimeR _id;
    std::string   _name;

  /// The collection of "visible" intervals

    CdbRooRoViCollectionR _intervals;

  // Additional descriptive information

    CdbRooRoTimeR _created;
    std::string   _description;

    ClassDef(CdbRooRoRevisionR,1);
};

#endif /* CDBROOREADONLY_REVISION_R_RDL */

---