OutputObjHeader.h

Go to the documentation of this file.

// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
 
#ifndef O2_FRAMEWORK_OUTPUTOBJHEADER_H_
#define O2_FRAMEWORK_OUTPUTOBJHEADER_H_
 
#include "Headers/DataHeader.h"
 
using BaseHeader = o2::header::BaseHeader;
 
namespace o2::framework
{
 
enum OutputObjHandlingPolicy : unsigned int {
  AnalysisObject,
  QAObject,
  TransientObject,
  numPolicies
};
 
enum OutputObjSourceType : unsigned int {
  OutputObjSource,
  HistogramRegistrySource,
  numTypes
};
 
struct OutputObjHeader : public BaseHeader {
  constexpr static const uint32_t sVersion = 1;
  constexpr static const uint32_t MAX_REGISTRY_NAME_SIZE = 128;
  constexpr static const o2::header::HeaderType sHeaderType = "OutObjMD";
  constexpr static const o2::header::SerializationMethod sSerializationMethod = o2::header::gSerializationMethodNone;
  OutputObjHandlingPolicy mPolicy;
  OutputObjSourceType mSourceType;
  uint32_t mTaskHash;
  uint16_t mPipelineIndex = 0;
  uint16_t mPipelineSize = 1;
  // Name of the actual container for the object, e.g. the HistogramRegistry name
  char containerName[MAX_REGISTRY_NAME_SIZE] = {0};
  // Wether or not the container should have a name
  char createContainer = false;
 
  constexpr OutputObjHeader()
    : BaseHeader(sizeof(OutputObjHeader), sHeaderType, sSerializationMethod, sVersion),
      mPolicy{OutputObjHandlingPolicy::AnalysisObject},
      mSourceType{OutputObjSourceType::OutputObjSource},
      mTaskHash{0} {}
  constexpr OutputObjHeader(OutputObjHandlingPolicy policy, OutputObjSourceType sourceType, uint32_t hash, uint16_t pipelineIndex, uint16_t pipelineSize)
    : BaseHeader(sizeof(OutputObjHeader), sHeaderType, sSerializationMethod, sVersion),
      mPolicy{policy},
      mSourceType{sourceType},
      mTaskHash{hash},
      mPipelineIndex{pipelineIndex},
      mPipelineSize{pipelineSize} {}
  constexpr OutputObjHeader(OutputObjHeader const&) = default;
};
 
} // namespace o2::framework
 
#endif // O2_FRAMEWORK_OUTPUTOBJHEADER_H_