---

CdbBdb2RooPayloadMrgConverter.hh

Go to the documentation of this file.

#ifndef CDBROOCONVERSIONFWK_BDB_2_ROO_PAYLOAD_MRG_CONVERTER_HH
#define CDBROOCONVERSIONFWK_BDB_2_ROO_PAYLOAD_MRG_CONVERTER_HH

// File and Version Information:
//      $Id: CdbBdb2RooPayloadMrgConverter.hh,v 1.3 2005/07/14 16:11:04 jtinslay Exp $

#include "CdbRooConversionFwk/CdbBdb2RooPayloadConverter.hh"

#include <string>

/// The specialized generic "P-R" abstract base class for user defined (merging) converters
/**
  * This base class allows to build "merging" converters which are supposed to construct
  * an output objects out of more than one input objects. Here is how to build
  * user defined converters based on this paradigme:
  *
  * 1. A user defined converter should derived from the current class
  *    using the public inheritance.
  *
  * 2. The user defined converter should implement the "userDefinedConversion()"
  *    conversion method re-defined below with an extended signature.
  *
  * 3. The list of extra objects passed to the conversion method will contain at
  *    least one object. The actual number and types of objects will depend on
  *     a use and on an implementation of a particular converter.
  */
template < class P,
           class R >
class CdbBdb2RooPayloadMrgConverter : public CdbBdb2RooPayloadConverter<P,R> {

private:

  /// A type of the converter
  /**
    * Implements the corresponding method defined by a base class or an interface.
    *
    * @see CdbRooConverterBase::mergingConverter()
    */
    virtual bool mergingConverter( ) const { return true; };

  /// Implement a user-defined conversion
  /**
    * Implements the corresponding method defined by a base class or an interface.
    *
    * @see CdbBdb2RooPayloadConverter::userDefinedConversion()
    */
    virtual CdbStatus userDefinedConversion( const BdbRef(BdbObject)& theInputObjectRef,
                                             R*&                      theOutputObjectPtr
                                           ) const;
protected:

  /// The default constructor
  /**
    * @see CdbBdb2RooPayloadConverter::CdbBdb2RooPayloadConverter()
    */
    CdbBdb2RooPayloadMrgConverter( );

  /// The copy constructor

    CdbBdb2RooPayloadMrgConverter( const CdbBdb2RooPayloadMrgConverter<P,R>& theOther );

  /// The assignment operator

    CdbBdb2RooPayloadMrgConverter<P,R>& operator=( const CdbBdb2RooPayloadMrgConverter<P,R>& theOther );

  /// Implement a user-defined conversion (merged version)
  /**
    * This pure virtual method is supposed to be implemented by subclasses for
    * the specified (in the constructor) pair of classes. However, unlike its regular version
    * this one will also take a list of extra objects to be merged with the main input
    * object to produce an output object. The list is guranteed to have at least one extra object.
    * An actual number of extra objects depends on a particular use and an implementation of
    * a user defined converter. It's also defined during a database conversion planing.
    *
    * The method will be invoked by the above implemented "::userDefinedConversion()" method.
    *
    * The method is supposed to return CdbStatus::Success in case of its successfull
    * completion, or any other value otherwise, which will be treated as a failure.
    * Also when a call is successfull then the ouput object pointer must be filled with
    * a valid pointer onto a nely created object.
    *
    * NOTES:
    *
    *   1. The output object's ownership is also expected to be returned with the object.
    *
    *   2. The method has the same name as for the "one-to-one" conversion, but it has
    *      a different signature.
    *
    * @see CdbBdb2RooPayloadMrgConverter::CdbBdb2RooPayloadMrgConverter()
    * @see CdbBdb2RooPayloadMrgConverter::userDefinedConversion()
    */
    virtual CdbStatus userDefinedConversion( const BdbRef(BdbObject)&                theMainInputObjectRef,
                                             const std::vector< BdbRef(BdbObject) >& theExtraObjectsList,
                                             R*&                                     theOutputObjectPtr
                                           ) const = 0;
public:

  /// The destructor.

    virtual ~CdbBdb2RooPayloadMrgConverter( );
};

#ifdef     BABAR_COMP_INST
#include "CdbRooConversionFwk/CdbBdb2RooPayloadMrgConverter.cc"
#endif  // BABAR_COMP_INST

#endif  // CDBROOCONVERSIONFWK_BDB_2_ROO_PAYLOAD_MRG_CONVERTER_HH

---