MooseEnumItem.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
 
// STL includes
#include <string>
 
class MooseEnumItem
{
public:
  static const int INVALID_ID;
  MooseEnumItem();
  MooseEnumItem(const std::string & name, const int & id = INVALID_ID);
  ~MooseEnumItem() = default;
  MooseEnumItem(const MooseEnumItem & other);
  MooseEnumItem(MooseEnumItem && /*other*/) = default;
  MooseEnumItem & operator=(const MooseEnumItem & other);
  MooseEnumItem & operator=(MooseEnumItem && /*other*/) = default;
 
 
  const int & id() const { return _id; }
  const std::string & name() const { return _name; }
  const std::string & rawName() const { return _raw_name; }
 
 
  operator int() const { return _id; }
  operator std::string() const { return _name; }
 
 
  bool operator==(const char * value) const;
  bool operator!=(const char * value) const;
 
  bool operator==(const std::string & value) const;
  bool operator!=(const std::string & value) const;
 
  bool operator==(int value) const { return _id == value; }
  bool operator!=(int value) const { return _id != value; }
 
  bool operator==(unsigned short value) const { return _id == value; }
  bool operator!=(unsigned short value) const { return _id != value; }
 
  bool operator==(const MooseEnumItem &) const;
  bool operator!=(const MooseEnumItem &) const;
 
  bool operator<(const MooseEnumItem & other) const
  {
    return _id != other._id ? _id < other._id : _name < other._name;
  }
 
  friend std::ostream & operator<<(std::ostream & out, const MooseEnumItem & item);
 
  void setID(const int & id);
 
private:
  std::string _raw_name;
 
  std::string _name;
 
  int _id;
};