---

CdbBdbSCell.hh

Go to the documentation of this file.

#ifndef CDBBDBSHARED_CELL_HH
#define CDBBDBSHARED_CELL_HH

// File and Version Information:
//      $Id: CdbBdbSCell.hh,v 1.4 2004/08/06 05:54:24 bartoldu Exp $

#include "BdbUtil/Bdb.hh"

#include "CdbBase/CdbCommon.hh"

#include "BdbTime/BdbTime.hh"

#include <iostream>

/// Object of this class represent "cells"
/**
  * Objects of this embedded class represent a "cell" in 2-dimesion space
  * of the VALIDITY and INSERTION timelines. Each cell is described by its
  * range it spans in both dimensions.
  *
  * The surface occupied by a cell has the following semantics:
  *
  *     [ beginValidity  , endValidity )
  *     [ beginInsertion , endInsertion )
  *
  *     INSERTION
  *             :   ........
  *             :  #       .
  *             :  #       .
  *             :  ########
  *             ..............VALIDITY
  */
class CdbBdbSCell {

public:

  // Default and normal constructors

    CdbBdbSCell( const BdbTime& theBeginValidity  = BdbTime::minusInfinity,
                 const BdbTime& theEndValidity    = BdbTime::plusInfinity,
                 const BdbTime& theBeginInsertion = BdbTime::minusInfinity,
                 const BdbTime& theEndInsertion   = BdbTime::plusInfinity );

  /// Copy constructor

    CdbBdbSCell( const CdbBdbSCell& theCell );

  /// The destructor
  /**
    * NOTE: The destructor is NOT virtual because this is an embedded
    *       class.
    */
    ~CdbBdbSCell( );

  /// The assignment operator
  /**
    */
    CdbBdbSCell& operator=( const CdbBdbSCell& theCell );

  /// Close the cell at specified point of the INSERTION timeline
  /**
    * The specified time must be strictly greater than the "bottom" insertion time
    * of the cell and be less or eqal to the "topmost" time. Otherwise the method will
    * abort the execution of an application.
    */
    void close( const BdbTime& theTime );

  /// The "equal" operator

    bool operator==( const CdbBdbSCell& theCell ) const;

  /// The "not-equal" operator

    inline bool operator!=( const CdbBdbSCell& theCell ) const
    {
        return ! operator==( theCell );
    }

  /// Check if specified point is inside the current cell

    bool in( const BdbTime& theValidityTime,
             const BdbTime& theInsertionTime ) const;

  /// Check if specified validity time is inside the validity range of the current cell

    bool inValidityRange( const BdbTime& theTime ) const;

  /// Check if specified cell overlaps with the current one
  /**
    * DEFINITION: Two cells are said to be "overlapped" when and only
    *             when the area of their intersection is more than 0.
    *
    * Please, take into account the definition of the cell given at
    * the beginning of this file.
    */
    bool overlap( const CdbBdbSCell& theCell ) const;

  /// Dump the object contents into a stream

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

public:

  // Non-mutable data members initialized by the constructor only

    const BdbTime beginValidity;
    const BdbTime endValidity;
    const BdbTime beginInsertion;
    const BdbTime endInsertion;
};

inline std::ostream&
operator<<( std::ostream&           o,
            const CdbBdbSCell& theCell )
{
    theCell.dump( o );
    return o;
}

#endif  // CDBBDBSHARED_CELL_HH

---