---

CdbBdbSSimpleClusterP.ddl

Go to the documentation of this file.

#ifndef CDBBDBSHARED_SIMPLE_CLUSTER_P_HH
#define CDBBDBSHARED_SIMPLE_CLUSTER_P_HH

// File and Version Information:
//      $Id: CdbBdbSSimpleClusterP.ddl,v 1.2 2002/09/23 22:41:12 gapon Exp $

#include "CdbBdbShared/CdbBdbSClusterP.hh"
#include "CdbBdbShared/CdbBdbSIncrementCollection.hh"

/// A simple cluster of conditions
/**
  * A simple cluster of conditions supports "increments".
  */
class CdbBdbSSimpleClusterP : public CdbBdbSClusterP {

private:

  /// Default constructor (IS DISABLED)

    CdbBdbSSimpleClusterP( );

public:

  /// Normal constructor
  /**
    * WARNING: Inappropriate values of the parameters will cause the crash
    *          of the constructor to avoid creating disformed persistent
    *          data structures.
    */
    CdbBdbSSimpleClusterP( const char*    theName,          /**< the name of the cluster */
                           d_UShort       theId,            /**< the identifier of the cluster */
                           const char*    theDescription,   /**< the description of the cluster */
                           const BdbTime& theCreationTime   /**< the time when the cluster is supposed to be created */
                         );

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

  /// Get the total number of "increments"
  /**
    */
    d_UShort numIncrements( ) const;

  /// Get the specified "increment"
  /**
    * The method will return CdbStatus::NotFound if the index is not
    * in a valid range.
    */
    CdbStatus increment( d_UShort          theNumber,           /**< the number of the increment in question */
                         CdbBdbSIncrement& theIncrement         /**< the value of the increment to be set up */
                       ) const;

  /// Create new "increment"
  /**
    * The method if successfull will increase the number of increments by one.
    */
    CdbStatus createIncrement( const BdbTime& theSplitTime      /**< the split time for a new incrementhe increment */
                             );

private:

  // This is an embedded class

    CdbBdbSIncrementCollection _increments;
};

#endif /* CDBBDBSHARED_SIMPLE_CLUSTER_P_HH */

---