MooseObjectName.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* 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 MooseObjectName
{
public:
  MooseObjectName(const std::string & tag,
                  const std::string & name,
                  const std::string & separator = std::string("/"));

  virtual ~MooseObjectName() = default;

  MooseObjectName(std::string name);

  MooseObjectName(const MooseObjectName & rhs);

  const std::string & name() const { return _name; }

  const std::string & tag() const { return _tag; }


  bool operator==(const MooseObjectName & rhs) const;
  bool operator!=(const MooseObjectName & rhs) const;
  bool operator<(const MooseObjectName & rhs) const;

  friend std::ostream & operator<<(std::ostream & stream, const MooseObjectName & obj);

protected:
  MooseObjectName();

  std::string _tag;
  std::string _name;
  std::string _combined;
  std::string _separator; // used for better error messages only

  virtual void check();
};