ReporterMode.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html
#pragma once

#include "MooseEnum.h"

class ReporterMode;
extern const ReporterMode REPORTER_MODE_UNSET;
extern const ReporterMode REPORTER_MODE_ROOT;
extern const ReporterMode REPORTER_MODE_REPLICATED;
extern const ReporterMode REPORTER_MODE_DISTRIBUTED;

class ReporterMode : public MooseEnumItem
{
public:
  ReporterMode(const std::string & key);

private:
  // Automatically incremented in construction
  static int ID_COUNTER;
};

class ReporterProducerEnum : public MooseEnum
{
public:
  ReporterProducerEnum();

  void clear();

  template <typename... Args>
  void insert(const ReporterMode & mode, Args... modes);
  void insert(const ReporterMode & mode);
};

inline bool
operator==(const ReporterProducerEnum & producer_mode, const ReporterMode & mode)
{
  return static_cast<int>(producer_mode) == static_cast<int>(mode);
}

inline bool
operator==(const ReporterMode & mode, const ReporterProducerEnum & producer_mode)
{
  return producer_mode == mode;
}

inline bool
operator!=(const ReporterProducerEnum & producer_mode, const ReporterMode & mode)
{
  return !(producer_mode == mode);
}

inline bool
operator!=(const ReporterMode & mode, const ReporterProducerEnum & producer_mode)
{
  return !(mode == producer_mode);
}

template <typename... Args>
void
ReporterProducerEnum::insert(const ReporterMode & mode, Args... modes)
{
  insert(mode);
  insert(modes...);
}