---

CdbBdbSConditionAtFolderP.ddl

Go to the documentation of this file.

#ifndef CDBBDBSHARED_CONDITION_AT_FOLDER_P_HH
#define CDBBDBSHARED_CONDITION_AT_FOLDER_P_HH

// File and Version Information:
//      $Id: CdbBdbSConditionAtFolderP.ddl,v 1.8 2004/08/06 05:54:24 bartoldu Exp $

#include "BdbUtil/Bdb.hh"

#include "CdbBdbShared/CdbBdbSId.hh"
#include "CdbBdbShared/CdbBdbSConfigCollectionP.hh"

#include <iostream>

//-----------------------------------------------
// Forward Declarations for Persistent Classes --
//-----------------------------------------------

class CdbBdbSViewP;
#pragma ooclassref CdbBdbSViewP "CdbBdbShared/CdbBdbSViewP_ref.hh"

class CdbBdbSFolderP;
#pragma ooclassref CdbBdbSFolderP "CdbBdbShared/CdbBdbSFolderP_ref.hh"

/// Class representing a condition at a view's folder
/**
  * Class CdbBdbSConditionAtFolderP. This persistent class represents
  * "condition at folder" objects, which are plaing two roles:
  *
  *   - as a representative of the corresponding "physical" conditions
  *     in the "virtual" namespace of a view.
  *
  *   - as a provider of the configuration information (revision, partition,
  *     etc.), which is used by clients looking for condition objects through
  *     the corrsponding view.
  */
class CdbBdbSConditionAtFolderP : public BdbPersObj {

friend class CdbBdbSViewP;      // who creates me or/and configures me
friend class CdbBdbSFolderP;    // who destroys me

private:

  /// Default constructor (NOT IMPLEMENTED))
  /**
    * Also see comments about the special constructor defined above.
    */
    CdbBdbSConditionAtFolderP( );

  /// Normal constructor
  /**
    * WARNING: Inappropriate values of the parameters will cause the crash
    *          of the constructor to avoid creating disformed persistent
    *          data structures.
    */
    CdbBdbSConditionAtFolderP( const char*                             theName,             /**< the name of the condition */
                               const char*                             theDescription,      /**< the description of the condition in the context of the parent folder */
                               const BdbTime&                          theCreationTime,     /**< the time when the condition entry is supposed to be created */
                               const CdbBdbSId&                        theId,               /**< the "extended" identifier of the "physical" condition */
                               const BdbRef(CdbBdbSFolderP)&           theParentFolderRef,  /**< back link to the parent folder */
                               const BdbRef(CdbBdbSConfigCollectionP)& theConfigRef = 0     /**< an optional configuration object */
                             );

  /// Destructor
  /**
    */
    virtual ~CdbBdbSConditionAtFolderP( );

  /// Set/override default configuration
  /**
    * The passed reference can be 0-0-0-0. The previously stored configuration
    * object (if any) will be destroyed unless an optional 'dontDestroyConfigObject'
    * flag is set to true.
    */
    CdbStatus setConfig( const BdbRef(CdbBdbSConfigCollectionP)& theConfigRef,                      /**< a configuration object */
                         bool                                    dontDestroyConfigObject = false    /**< an optional flag */
                       );

public:

  // Accessors

    ooString(32) name       ( ) const;
    ooString(32) description( ) const;

    BdbTime created( ) const;

    CdbBdbSId id( ) const;

    BdbRef(CdbBdbSFolderP)           parentFolder( ) const;
    BdbRef(CdbBdbSConfigCollectionP) config      ( ) const;

  /// Find the value of the configuration and its interval of validity...
  /**
    * ...where the specified validity time falls into.
    *
    * NOTES:
    *
    * - the local configuration (if any) at the condition's level will take precedence
    *   over the view's default configuration.
    *
    * - the restriction in the validity interval covered by this view is also taken
    *   into account. So the returned interval of the configuration will never
    *   exceed these limits.
    *
    * - if there is no configuration found for specified time (either due to
    *   out-of-supported-range value of the time, or due to missing configuration,
    *   which is basically a sign that the view is incomplete) then Cdbstatus::NotFound
    *   is returned.
    */
    CdbStatus find( const BdbTime&         theTime,             /**< the validity time */
                    CdbBdbSConfigInterval& theConfigInterval    /**< the configuration interval to be set up upon completion */
                  ) const;

  /// Dump the contents of the object
  /**
    */
    void dump( std::ostream& o ) const;

private:

  // Data members

    ooString(32) _name;
    ooString(32) _description;

    BdbTime _created;

    CdbBdbSId _id;

    BdbRef(CdbBdbSFolderP)           _parentFolderRef;
    BdbRef(CdbBdbSConfigCollectionP) _configRef;
};

#endif /* CDBBDBSHARED_CONDITION_AT_FOLDER_P_HH */

---