---

CdbStateId.hh

Go to the documentation of this file.

#ifndef CDB_STATE_ID_HH
#define CDB_STATE_ID_HH

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

#include "CdbBase/CdbId.hh"

#include "BdbTime/BdbTime.hh"

#include <iostream>

/// The "State Identifier" class
/**
  * Objects of this class are meant to identify the state of the Condition/DB
  * where it seems appropriate.
  */
class CdbStateId {

public:

  /// Default constructor
  /**
    * Sets an object into unusable state
    */
    CdbStateId( );

  /// The normal constructor
  /**
    * Loads an object with both identifier of a view and the most recent
    * modification time of the Condition/DB done in teh scope of the view.
    */
    CdbStateId( const CdbId&   theViewId,
                const BdbTime& theModificationTime );

  /// The copy constructor
  /**
    * More details...
    */
    CdbStateId( const CdbStateId& theId );

  /// The asignment operator
  /**
    * More details...
    */
    CdbStateId& operator=( const CdbStateId& theId );

  /// The "equal" operator
  /**
    * Two objects are equal only if they have _exactly_ the same contents.
    */
    bool operator==( const CdbStateId& theId ) const;

  /// The "not-equal" operator
  /**
    * @see CdbStateId::operator==()
    */
    inline bool operator!=( const CdbStateId& theId ) const;

  // Accessors

    inline CdbId   viewId          ( ) const;
    inline BdbTime modificationTime( ) const;

  /// Check if the identifier is in the valid state.
  /**
    * One way the object may get into the non valid state is to initialize
    * the object through the default constructor.
    */
    bool isValid( ) const;

private:

    CdbId   _viewId;
    BdbTime _modificationTime;
};

// Inline implementations for the methods and operators of the class

inline
bool
CdbStateId::operator!=( const CdbStateId& theId ) const
{
    return ! operator==( theId );
}

inline
CdbId
CdbStateId::viewId( ) const
{
    return _viewId;
}

inline
BdbTime
CdbStateId::modificationTime( ) const
{
    return _modificationTime;
}

inline
std::ostream&
operator<<( std::ostream&          o,
            const CdbStateId& theId )
{
    o << theId.viewId( ) << " [ " << theId.modificationTime( ) << " ]";
    return o;
}
#endif  // CDB_STATE_ID_HH

---