Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

CdbBdbSRebuildAction Class Reference

An interface for the user defined "rebuild action" objects. More...

#include <CdbBdbSRebuildAction.hh>

List of all members.

Public Types

enum  ActionType { ACTION_COPY = 0, ACTION_DO_NOT_COPY, ACTION_ERROR }
 The action type. More...


Public Member Functions

virtual ~CdbBdbSRebuildAction ()
 The destructor.

virtual ActionType userAction (CdbBdbSOi &theInterval)=0
 Let a user to evaluate the specified interval.

Detailed Description

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 also:
CdbBdbSMetaDataP:: rebuild()

Definition at line 20 of file CdbBdbSRebuildAction.hh.

Member Enumeration Documentation

enum CdbBdbSRebuildAction::ActionType
 

The action type.

Enumeration values:
ACTION_COPY 
ACTION_DO_NOT_COPY 
ACTION_ERROR 

Definition at line 26 of file CdbBdbSRebuildAction.hh.

Referenced by CdbBdbSMetaDataP::rebuild().

Constructor & Destructor Documentation

CdbBdbSRebuildAction::~CdbBdbSRebuildAction (    )  [virtual]
 

The destructor.

The destructor is made virtual to ensure correct destruction of objects of inherited classes.

Definition at line 13 of file CdbBdbSRebuildAction.cc.

Member Function Documentation

virtual ActionType CdbBdbSRebuildAction::userAction (  CdbBdbSOi &    theInterval )  [pure virtual]
 

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.

Referenced by CdbBdbSMetaDataP::rebuild().

The documentation for this class was generated from the following files:
Generated on Mon Dec 5 18:22:20 2005 for CDB by doxygen1.3-rc3