---

CdbBdbSRebuildAction.hh

Go to the documentation of this file.

#ifndef CDBBDBSHARED_REBUILD_ACTION_HH
#define CDBBDBSHARED_REBUILD_ACTION_HH

// File and Version Information:
//      $Id: CdbBdbSRebuildAction.hh,v 1.1 2003/06/27 03:26:22 gapon Exp $

#include "CdbBdbShared/CdbBdbSOi.hh"

/// An interface for the user defined "rebuild action" objects
/**
  * This interface is used by CdbBdbSMetaDataP:: rebuild() method to determine
  * what to do with 'original' intervals found in an input collection when rebuilding
  * its metadata object.
  *
  * Developers are supposed to implement the only virtual method declared
  * in this interface.
  *
  * @see CdbBdbSMetaDataP:: rebuild()
  */
class CdbBdbSRebuildAction {

public:

  /// The action type

    typedef enum { ACTION_COPY = 0,
                   ACTION_DO_NOT_COPY,
                   ACTION_ERROR
    } ActionType;

public:

  /// The destructor
  /**
    * The destructor is made virtual to ensure correct destruction of objects
    * of inherited classes.
    */
    virtual ~CdbBdbSRebuildAction( );

  /// Let a user to evaluate the specified interval
  /**
    * This method is supposed to evaluate the passed interval, modify it
    * if needed and return a conclusion what to do with the interval.
    *
    * Here is the explanation of actions returned by this method:
    *
    *   ACTION_COPY        : the interval has to be copied into the output collection.
    *                        Note that the interval may be modified after calling this method.
    *
    *   ACTION_DO_NOT_COPY : the interval shoul NOT be copied. The interval is guaranteed
    *                        not to be modified if this status is returned.
    *
    *   ACTION_ERROR       : a error has accured when the method was trying to evaluate
    *                        the specified interval. The interval is guaranteed
    *                        not to be modified if this status is returned.
    */
    virtual ActionType userAction( CdbBdbSOi& theInterval ) = 0;
};

#endif  // CDBBDBSHARED_REBUILD_ACTION_HH

---