---

CdbPartition.hh

Go to the documentation of this file.

#ifndef CDB_PARTITION_HH
#define CDB_PARTITION_HH

// File and Version Information:
//      $Id: CdbPartition.hh,v 1.5 2004/08/06 05:54:14 bartoldu Exp $

#include "CdbBase/CdbCPtrBase.hh"
#include "CdbBase/CdbPartitionPtrFwd.hh"
#include "CdbBase/CdbDatabasePtrFwd.hh"

#include "BdbTime/BdbTime.hh"

#include <string>

/// The transient interface to a partition object.
/**
  * More details to come...
  */
class CdbPartition {

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

private:

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

  /// The copy constructor (NOT IMPLEMENTED)
  /**
    * Is disabled...
    */
    CdbPartition( const CdbPartition& thePartition );

  /// The assignment operator (NOT IMPLEMENTED)
  /**
    * Is disabled...
    */
    CdbPartition& operator=( const CdbPartition& thePartition );

protected:

  /// The normal constructor.
  /**
    * Initialize context with specified "stable" parameters (those ones that
    * could not be changed during the life time of the partition.). The "dynamic"
    * parameters of the partition are available through the virtual methods.
    */
    CdbPartition( const CdbDatabasePtr& theDatabasePtr,     /**< the smart pointer providing a back back link to the parent database object */
                  unsigned short        theId,              /**< the partition identifier */
                  unsigned short        theOwnerId,         /**< the owner origin of the partiton */
                  const char*           theOwnerName,       /**< the owner origin of the partiton */
                  const char*           theDescription,     /**< the description of the partition */
                  const BdbTime&        theCreationTime,    /**< the creation time */
                  const BdbTime&        theBeginValidity,   /**< where the "validity" interval begins */
                  const BdbTime&        theEndValidity,     /**< where the "validity" interval std::ends */
                  const BdbTime&        theBeginInsertion   /**< where the "insertion" interval begins */
                );

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

public:

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

  /// The identifier of the partition

    unsigned short id( ) const;

  /// The identifier of the partition's owner

    unsigned short ownerId( ) const;

  /// The name of the partition's owner

    std::string ownerName( ) const;

  /// The name of the partition's owner

    std::string description( ) const;

  /// The creation time of the partition

    BdbTime created( ) const;

  /// The begin time in the "validity" dimension

    BdbTime beginValidity( ) const;

  /// The end time in the "validity" dimension

    BdbTime endValidity( ) const;

  /// The begin time in the "insertion" dimension

    BdbTime beginInsertion( ) const;

  /// The begin time in the "insertion" dimension

    virtual BdbTime endInsertion( ) const = 0;

  /// The recent modification time of the partition
  /**
    * This time is increased when any of partitionable conditions
    * are updated (new objects are written, new revisions get created)
    * within the validity/insertion time limits of the partition.
    * Only "open" partitions can be updated.
    */
    virtual BdbTime modified( ) const = 0;

  /// The status of the partition
  /**
    * The partiton is "closed" if it's not allowed for writing into it even by its
    * owner origin. Normally a partition gets into this state when a new one is created
    * above it in the "insertion" time dimension. Eeffectively a "closed" partition
    * becomes the read-only one.
    */
    virtual bool isClosed( ) const = 0;

  /// The status of the partition
  /**
    * The partiton can only be "instantiated" by its owner origin to allow
    * writing into or reading from it. Non-ownes of a partition are not allowed
    * to read from a partition untill it gets "instantiated" by the owner and shipped
    * to a local origin (database).
    */
    virtual bool isInstantiated( ) const = 0;

private:

    CdbDatabasePtr _myParent;
    unsigned short _id;

    unsigned short _ownerId;
    std::string    _ownerName;

    std::string _description;

    BdbTime _created;

    BdbTime _beginValidity;
    BdbTime _endValidity;
    BdbTime _beginInsertion;
};

#endif  // CDB_PARTITION_HH

---