art::MixOp< Prod, OProd > Class Template Reference

#include "MixOp.h"

Inheritance diagram for art::MixOp< Prod, OProd >:

Public Member Functions
template<typename FUNC >
	MixOp (std::string const &moduleLabel, InputTag const &inputTag, std::string const &outputInstanceLabel, FUNC mixFunc, bool outputProduct, bool compactMissingProducts, BranchType bt)
InputTag const &	inputTag () const override
TypeID	inputType () const override
EDProduct const *	newIncomingWrappedProduct () const override
ProductID	incomingProductID () const override
ProductID	outgoingProductID () const override
BranchType	branchType () const override

Private Member Functions
void	mixAndPut (Event &e, SpecProdList const &inProducts, PtrRemapper const &remap) const override
void	setIncomingProductID (ProductID) override

Private Attributes
InputTag const	inputTag_
std::string const	outputInstanceLabel_
TypeID const	inputType_
MixFunc< Prod, OProd > const	mixFunc_
std::string const	processName_
std::string const	moduleLabel_
bool const	outputProduct_
bool const	compactMissingProducts_
BranchType const	branchType_
ProductID	incomingProductID_ {ProductID::invalid()}

Detailed Description

template<typename Prod, typename OProd>
class art::MixOp< Prod, OProd >

Definition at line 30 of file MixOp.h.

Constructor & Destructor Documentation

template<typename Prod , typename OProd >

template<typename FUNC >

art::MixOp< Prod, OProd >::MixOp	(	std::string const &	moduleLabel,
		InputTag const &	inputTag,
		std::string const &	outputInstanceLabel,
		FUNC	mixFunc,
		bool	outputProduct,
		bool	compactMissingProducts,
		BranchType	bt
	)

Definition at line 80 of file MixOp.h.

References art::MixOp< Prod, OProd >::branchType_, art::MixOp< Prod, OProd >::compactMissingProducts_, art::MixOp< Prod, OProd >::inputType_, art::Globals::instance(), art::MixOp< Prod, OProd >::mixFunc_, art::MixOp< Prod, OProd >::moduleLabel_, art::MixOp< Prod, OProd >::outputInstanceLabel_, art::MixOp< Prod, OProd >::outputProduct_, art::Globals::processName(), and art::MixOp< Prod, OProd >::processName_.

    : inputTag_{inputTag}
    , outputInstanceLabel_{outputInstanceLabel}
    , inputType_{typeid(Prod)}
    , mixFunc_{mixFunc}
    , processName_{Globals::instance()->processName()}
    , moduleLabel_{moduleLabel}
    , outputProduct_{outputProduct}
    , compactMissingProducts_{compactMissingProducts}
    , branchType_{bt}
  {}

Member Function Documentation

template<typename Prod , typename OProd >

BranchType art::MixOp< Prod, OProd >::branchType ( ) const

inlineoverridevirtual

Implements art::MixOpBase.

Definition at line 167 of file MixOp.h.

References art::MixOp< Prod, OProd >::branchType_.

Referenced by art::MixOp< Prod, OProd >::newIncomingWrappedProduct().

  {
    return branchType_;
  }

template<typename Prod , typename OProd >

ProductID art::MixOp< Prod, OProd >::incomingProductID ( ) const

overridevirtual

Implements art::MixOpBase.

Definition at line 142 of file MixOp.h.

References art::MixOp< Prod, OProd >::incomingProductID_.

Referenced by art::MixOp< Prod, OProd >::newIncomingWrappedProduct().

  {
    return incomingProductID_;
  }

template<typename Prod , typename OProd >

InputTag const& art::MixOp< Prod, OProd >::inputTag ( ) const

inlineoverridevirtual

Implements art::MixOpBase.

Definition at line 42 of file MixOp.h.

References art::MixOp< Prod, OProd >::inputTag_.

    {
      return inputTag_;
    }

template<typename Prod , typename OProd >

TypeID art::MixOp< Prod, OProd >::inputType ( ) const

inlineoverridevirtual

Implements art::MixOpBase.

Definition at line 47 of file MixOp.h.

References art::MixOp< Prod, OProd >::inputType_.

    {
      return inputType_;
    }

template<typename Prod , typename OProd >

void art::MixOp< Prod, OProd >::mixAndPut ( Event &  e, SpecProdList const &  inProducts, PtrRemapper const &  remap  ) const

overrideprivatevirtual

Implements art::MixOpBase.

Definition at line 100 of file MixOp.h.

References art::MixOp< Prod, OProd >::compactMissingProducts_, art::errors::DataCorruption, art::errors::LogicError, art::MixOp< Prod, OProd >::mixFunc_, art::MixOp< Prod, OProd >::outputInstanceLabel_, art::MixOp< Prod, OProd >::outputProduct_, and art::Event::put().

Referenced by art::MixOp< Prod, OProd >::newIncomingWrappedProduct().

  {
    std::vector<Prod const*> inConverted;
    inConverted.reserve(inProducts.size());
    try {
      for (auto const& ep : inProducts) {
        auto const prod =
          std::dynamic_pointer_cast<Wrapper<Prod> const>(ep)->product();
        if (prod || !compactMissingProducts_) {
          inConverted.emplace_back(prod);
        }
      }
    }
    catch (std::bad_cast const&) {
      throw Exception(errors::DataCorruption)
        << "Unable to obtain correctly-typed product from wrapper.\n";
    }

    auto rProd = std::make_unique<OProd>();
    // False means don't want this in the event.
    if (mixFunc_(inConverted, *rProd, remap)) {
      if (!outputProduct_) {
        throw Exception(errors::LogicError)
          << "Returned true (output product to be put in event) from a mix "
             "function\n"
          << "declared with outputProduct=false.\n";
      }
      e.put(std::move(rProd), outputInstanceLabel_);
    }
  }

template<typename Prod , typename OProd >

EDProduct const* art::MixOp< Prod, OProd >::newIncomingWrappedProduct ( ) const

inlineoverridevirtual

Implements art::MixOpBase.

Definition at line 52 of file MixOp.h.

References art::MixOp< Prod, OProd >::branchType(), e, art::MixOp< Prod, OProd >::incomingProductID(), art::MixOp< Prod, OProd >::mixAndPut(), art::MixOp< Prod, OProd >::outgoingProductID(), and art::MixOp< Prod, OProd >::setIncomingProductID().

    {
      return new Wrapper<Prod>{};
    }

template<typename Prod , typename OProd >

ProductID art::MixOp< Prod, OProd >::outgoingProductID ( ) const

overridevirtual

Implements art::MixOpBase.

Definition at line 149 of file MixOp.h.

References art::canonicalProductName(), art::MixOp< Prod, OProd >::moduleLabel_, art::MixOp< Prod, OProd >::outputInstanceLabel_, art::MixOp< Prod, OProd >::outputProduct_, and art::MixOp< Prod, OProd >::processName_.

Referenced by art::MixOp< Prod, OProd >::newIncomingWrappedProduct().

  {
    ProductID result;
    if (outputProduct_) {
      TypeID const outputType{typeid(OProd)};
      // Note: Outgoing product must be InEvent.
      auto const productName =
        canonicalProductName(outputType.friendlyClassName(),
                             moduleLabel_,
                             outputInstanceLabel_,
                             processName_);
      result = ProductID{productName};
    }
    return result;
  }

template<typename Prod , typename OProd >

void art::MixOp< Prod, OProd >::setIncomingProductID ( ProductID  prodID )

overrideprivatevirtual

Implements art::MixOpBase.

Definition at line 135 of file MixOp.h.

References art::MixOp< Prod, OProd >::incomingProductID_.

Referenced by art::MixOp< Prod, OProd >::newIncomingWrappedProduct().

  {
    incomingProductID_ = prodID;
  }

Member Data Documentation

template<typename Prod , typename OProd >

BranchType const art::MixOp< Prod, OProd >::branchType_

private

Definition at line 74 of file MixOp.h.

Referenced by art::MixOp< Prod, OProd >::branchType(), and art::MixOp< Prod, OProd >::MixOp().

template<typename Prod , typename OProd >

bool const art::MixOp< Prod, OProd >::compactMissingProducts_

private

Definition at line 73 of file MixOp.h.

Referenced by art::MixOp< Prod, OProd >::mixAndPut(), and art::MixOp< Prod, OProd >::MixOp().

template<typename Prod , typename OProd >

ProductID art::MixOp< Prod, OProd >::incomingProductID_ {ProductID::invalid()}

private

Definition at line 75 of file MixOp.h.

Referenced by art::MixOp< Prod, OProd >::incomingProductID(), and art::MixOp< Prod, OProd >::setIncomingProductID().

template<typename Prod , typename OProd >

InputTag const art::MixOp< Prod, OProd >::inputTag_

private

Definition at line 66 of file MixOp.h.

Referenced by art::MixOp< Prod, OProd >::inputTag().

template<typename Prod , typename OProd >

TypeID const art::MixOp< Prod, OProd >::inputType_

private

Definition at line 68 of file MixOp.h.

Referenced by art::MixOp< Prod, OProd >::inputType(), and art::MixOp< Prod, OProd >::MixOp().

template<typename Prod , typename OProd >

MixFunc<Prod, OProd> const art::MixOp< Prod, OProd >::mixFunc_

private

Definition at line 69 of file MixOp.h.

Referenced by art::MixOp< Prod, OProd >::mixAndPut(), and art::MixOp< Prod, OProd >::MixOp().

template<typename Prod , typename OProd >

std::string const art::MixOp< Prod, OProd >::moduleLabel_

private

Definition at line 71 of file MixOp.h.

Referenced by art::MixOp< Prod, OProd >::MixOp(), and art::MixOp< Prod, OProd >::outgoingProductID().

template<typename Prod , typename OProd >

std::string const art::MixOp< Prod, OProd >::outputInstanceLabel_

private

Definition at line 67 of file MixOp.h.

Referenced by art::MixOp< Prod, OProd >::mixAndPut(), art::MixOp< Prod, OProd >::MixOp(), and art::MixOp< Prod, OProd >::outgoingProductID().

template<typename Prod , typename OProd >

bool const art::MixOp< Prod, OProd >::outputProduct_

private

Definition at line 72 of file MixOp.h.

Referenced by art::MixOp< Prod, OProd >::mixAndPut(), art::MixOp< Prod, OProd >::MixOp(), and art::MixOp< Prod, OProd >::outgoingProductID().

template<typename Prod , typename OProd >

std::string const art::MixOp< Prod, OProd >::processName_

private

Definition at line 70 of file MixOp.h.

Referenced by art::MixOp< Prod, OProd >::MixOp(), and art::MixOp< Prod, OProd >::outgoingProductID().

---

The documentation for this class was generated from the following file:

• art/Framework/IO/ProductMix/MixOp.h