MooseObjectParameterName Class Reference

A class for storing an input parameter name. More...

#include <MooseObjectParameterName.h>

Inheritance diagram for MooseObjectParameterName:

Public Member Functions
	MooseObjectParameterName (std::string name)
	Build an object given a raw parameter name (e.g., from an input file parameter) More...
	MooseObjectParameterName (const MooseObjectName &obj_name, const std::string &param)
	Build an object given a MooseObjectName and parameter name. More...
	MooseObjectParameterName (const std::string &tag, const std::string &name, const std::string &param, const std::string &separator=std::string("/"))
	Build an object given a tag, object name, and parameter name. More...
	MooseObjectParameterName (const MooseObjectParameterName &rhs)
const std::string &	parameter () const
	Return the parameter name. More...
virtual void	check () final
	Adds the parameter name to error checking. More...
const std::string &	name () const
	Return the name. More...
const std::string &	tag () const
	Return the tag. More...
bool	operator== (const MooseObjectParameterName &rhs) const
	Comparison operators. More...
bool	operator== (const MooseObjectName &rhs) const
bool	operator!= (const MooseObjectParameterName &rhs) const
bool	operator!= (const MooseObjectName &rhs) const
bool	operator< (const MooseObjectParameterName &rhs) const
bool	operator< (const MooseObjectName &rhs) const

Protected Attributes
std::string	_parameter
	The name of the input parameter. More...
std::string	_tag
std::string	_name
std::string	_combined
std::string	_separator

Friends
std::ostream &	operator<< (std::ostream &stream, const MooseObjectParameterName &obj)

Detailed Description

A class for storing an input parameter name.

This class is used by the Control logic system, allowing for multiple tags to be applied to many different MooseObject parameters.

This class simply adds a third field (parameter name) to the MooseObjectName class.

Definition at line 26 of file MooseObjectParameterName.h.

Constructor & Destructor Documentation

MooseObjectParameterName() [1/4]

MooseObjectParameterName::MooseObjectParameterName

(

std::string

name

)

Build an object given a raw parameter name (e.g., from an input file parameter)

Definition at line 39 of file MooseObjectParameterName.C.

                                                                 : MooseObjectName()
{
  // The tag precedes the :: (this is used in _moose_base::name and control_tag::name conventions)
  std::size_t idx = name.find("::");
  if (idx != std::string::npos)
  {
    _tag = name.substr(0, idx);
    name.erase(0, idx + 2);
    _separator = "::";
  }

  // Locate the param name
  idx = name.rfind("/");
  if (idx != std::string::npos)
  {
    _parameter = name.substr(idx + 1);
    name.erase(idx);
  }
  else // if a slash isn't located then the entire name must be the parameter
  {
    _parameter = name;
    name.erase();
  }

  // If there is a second slash, there is a syntax based tag: tag/object_name/param
  idx = name.rfind("/");
  if (idx != std::string::npos)
  {
    _name = name.substr(idx + 1);
    name.erase(idx);
    _tag = name;
  }

  // If content still exists in "name", then this must be the object name
  if (_name.empty() && !name.empty())
    _name = name;

  // Set the combined name for sorting
  _combined = _tag + _name + _parameter;
}

MooseObjectParameterName() [2/4]

MooseObjectParameterName::MooseObjectParameterName	(	const MooseObjectName &	obj_name,
		const std::string &	param
	)

Build an object given a MooseObjectName and parameter name.

Definition at line 17 of file MooseObjectParameterName.C.

  : MooseObjectName(obj_name), _parameter(param)
{
  _combined = _tag + _name + _parameter;
}

MooseObjectParameterName() [3/4]

MooseObjectParameterName::MooseObjectParameterName	(	const std::string &	tag,
		const std::string &	name,
		const std::string &	param,
		const std::string &	separator = std::string("/")
	)

Build an object given a tag, object name, and parameter name.

Definition at line 24 of file MooseObjectParameterName.C.

  : MooseObjectName(tag, name, separator), _parameter(param)
{
  _combined += _parameter;
}

MooseObjectParameterName() [4/4]

MooseObjectParameterName::MooseObjectParameterName

(

const MooseObjectParameterName &

rhs

)

Definition at line 33 of file MooseObjectParameterName.C.

  : MooseObjectName(rhs._tag, rhs._name, rhs._separator), _parameter(rhs._parameter)
{
  _combined = _tag + _name + _parameter;
}

Member Function Documentation

check()

void MooseObjectParameterName::check ( )

finalvirtual

Adds the parameter name to error checking.

Reimplemented from MooseObjectName.

Definition at line 127 of file MooseObjectParameterName.C.

{
  MooseObjectName::check();
  if (_parameter.empty())
    mooseError("The supplied parameter name cannot be empty, to allow for any parameter name to be "
               "supplied use the '*' character.");
}

name()

const std::string& MooseObjectName::name ( ) const

inlineinherited

Return the name.

Definition at line 71 of file MooseObjectName.h.

Referenced by InputParameterWarehouse::addControllableObjectAlias(), MooseObjectName::MooseObjectName(), and MooseObjectParameterName().

{ return _name; }

operator!=() [1/2]

bool MooseObjectParameterName::operator!=

(

const MooseObjectParameterName &

rhs

)

const

Definition at line 96 of file MooseObjectParameterName.C.

{
  return !(*this == rhs);
}

operator!=() [2/2]

bool MooseObjectParameterName::operator!=

(

const MooseObjectName &

rhs

)

const

Definition at line 102 of file MooseObjectParameterName.C.

{
  return MooseObjectName::operator!=(rhs);
}

operator<() [1/2]

bool MooseObjectParameterName::operator<

(

const MooseObjectParameterName &

rhs

)

const

Definition at line 108 of file MooseObjectParameterName.C.

{
  return (_combined < rhs._combined);
}

operator<() [2/2]

bool MooseObjectName::operator< ( const MooseObjectName &  rhs ) const

inherited

Definition at line 79 of file MooseObjectName.C.

{
  return (_combined < rhs._combined);
}

operator==() [1/2]

bool MooseObjectParameterName::operator==

(

const MooseObjectParameterName &

rhs

)

const

Comparison operators.

Not that this class may be compared with MooseObjectName, this feature is used by ControlInterface.

The less than operator is required so this container can work in std::map.

See also

InputParameterWarehouse

Definition at line 81 of file MooseObjectParameterName.C.

{
  if (MooseObjectName::operator==(rhs) &&
      (_parameter == rhs._parameter || _parameter == "*" || rhs._parameter == "*"))
    return true;
  return false;
}

operator==() [2/2]

bool MooseObjectParameterName::operator==

(

const MooseObjectName &

rhs

)

const

Definition at line 90 of file MooseObjectParameterName.C.

{
  return MooseObjectName::operator==(rhs);
}

parameter()

const std::string& MooseObjectParameterName::parameter ( ) const

inline

Return the parameter name.

Definition at line 52 of file MooseObjectParameterName.h.

{ return _parameter; }

tag()

const std::string& MooseObjectName::tag ( ) const

inlineinherited

Return the tag.

Definition at line 76 of file MooseObjectName.h.

{ return _tag; }

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  stream, const MooseObjectParameterName &  obj  )

friend

Definition at line 114 of file MooseObjectParameterName.C.

{
  if (obj._tag.empty() && obj._name.empty())
    return stream << obj._parameter;
  else if (obj._tag.empty())
    return stream << obj._name << "/" << obj._parameter;
  else if (obj._name.empty())
    return stream << obj._tag << obj._separator << obj._parameter;
  else
    return stream << obj._tag << obj._separator << obj._name << "/" << obj._parameter;
}

Member Data Documentation

_combined

std::string MooseObjectName::_combined

protectedinherited

Definition at line 104 of file MooseObjectName.h.

Referenced by MooseObjectName::MooseObjectName(), MooseObjectParameterName(), operator<(), and MooseObjectName::operator<().

_name

std::string MooseObjectName::_name

protectedinherited

Definition at line 103 of file MooseObjectName.h.

Referenced by MooseObjectName::check(), MooseObjectName::MooseObjectName(), MooseObjectParameterName(), MooseObjectName::name(), operator<<(), and MooseObjectName::operator==().

_parameter

std::string MooseObjectParameterName::_parameter

protected

The name of the input parameter.

Definition at line 84 of file MooseObjectParameterName.h.

Referenced by check(), MooseObjectParameterName(), operator<<(), operator==(), and parameter().

_separator

std::string MooseObjectName::_separator

protectedinherited

Definition at line 105 of file MooseObjectName.h.

Referenced by MooseObjectName::MooseObjectName(), MooseObjectParameterName(), and operator<<().

_tag

std::string MooseObjectName::_tag

protectedinherited

Storage for the various name components

Definition at line 102 of file MooseObjectName.h.

Referenced by MooseObjectName::check(), MooseObjectName::MooseObjectName(), MooseObjectParameterName(), operator<<(), MooseObjectName::operator==(), and MooseObjectName::tag().

---

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

• include/utils/MooseObjectParameterName.h
• src/utils/MooseObjectParameterName.C