ControllableItem Class Reference

An intermediate object for building a "controllable item", where an "item" can refer to multiple input parameters with different names. More...

#include <ControllableItem.h>

Inheritance diagram for ControllableItem:

Public Member Functions
	ControllableItem (const MooseObjectParameterName &name, libMesh::Parameters::Value *value, const std::set< ExecFlagType > &flags={})
virtual	~ControllableItem ()=default
	ControllableItem (const ControllableItem &)=default
	ControllableItem (ControllableItem &&)=default
ControllableItem &	operator= (const ControllableItem &)=delete
ControllableItem &	operator= (ControllableItem &&)=delete
void	connect (ControllableItem *item, bool type_check=true)
	Connects the supplied item with this item to allow for multiple parameters to be changed by one. More...
template<typename T >
void	set (const T &value, bool type_check=true)
	Set the value(s) of the controlled parameters stored in this class. More...
template<typename T >
std::vector< T >	get (bool type_check=true) const
	Return a copy of all values for this "item". More...
template<typename T >
bool	check () const
	Return true if the template argument is valid for ALL items. More...
virtual const MooseObjectParameterName &	name () const
	Return the name of the master parameter. More...
std::string	type () const
	Return the type of the master parameter. More...
virtual std::string	dump (unsigned int indent=0) const
	Returns a string displaying the parameter name and current value. More...
const std::set< ExecFlagType > &	getExecuteOnFlags () const
	Return the execute flag restrictions, an empty set is un-restricted. More...
bool	operator== (const ControllableItem &rhs) const
	Use the master name for comparison operators to allow object to work within a set/map. More...
bool	operator!= (const ControllableItem &rhs) const
bool	operator< (const ControllableItem &rhs) const
void	resetChanged ()
	Methods for ControlOutput::outputChangedControls, these don't have meaning outside of this function. More...
bool	isChanged ()

Protected Member Functions
	ControllableItem ()
	Constructor for creating an empty item (see ControllableAlias) More...

Protected Attributes
std::vector< std::pair< MooseObjectParameterName, libMesh::Parameters::Value * > >	_pairs
	List of names for this item. More...
bool	_changed = false
	Flag for ControlOutput, allows output objects to keep track of when a parameter is altered. More...
std::set< ExecFlagType >	_execute_flags
	Flags to which the control is restricted (if not set it is unrestricted) More...

Friends
std::ostream &	operator<< (std::ostream &stream, const ControllableItem &obj)
	Allows this to be used with std:: cout. More...

Detailed Description

An intermediate object for building a "controllable item", where an "item" can refer to multiple input parameters with different names.

The name supplied to the constructor is considered the "master" parameter. The parameter(s) added via the connect method are considered the slaves.

In general, an ControllableItem will have a one-to-one relationship with an input parameter value, but in some instances it is desirable to connect parameters with different names together. For example, within MOOSE when a material is defined in an input file multiple Material objects are generated automatically. If a parameter is controlled on one of these objects it is necessary to also have the values on the other controlled as well. This example is the driver behind the creation of this intermediate class.

Definition at line 32 of file ControllableItem.h.

Constructor & Destructor Documentation

ControllableItem() [1/4]

ControllableItem::ControllableItem	(	const MooseObjectParameterName &	name,
		libMesh::Parameters::Value *	value,
		const std::set< ExecFlagType > &	flags = {}
	)

Definition at line 13 of file ControllableItem.C.

  : _execute_flags(flags)
{
  _pairs.emplace_back(name, value);
}

~ControllableItem()

virtual ControllableItem::~ControllableItem ( )

virtualdefault

ControllableItem() [2/4]

ControllableItem::ControllableItem ( const ControllableItem &  )

default

ControllableItem() [3/4]

ControllableItem::ControllableItem ( ControllableItem &&  )

default

ControllableItem() [4/4]

ControllableItem::ControllableItem ( )

protected

Constructor for creating an empty item (see ControllableAlias)

Definition at line 21 of file ControllableItem.C.

{}

Member Function Documentation

check()

template<typename T >

bool ControllableItem::check

(

)

const

Return true if the template argument is valid for ALL items.

Definition at line 176 of file ControllableItem.h.

{
  return std::all_of(_pairs.begin(),
                     _pairs.end(),
                     [](std::pair<MooseObjectParameterName, libMesh::Parameters::Value *> pair) {
                       libMesh::Parameters::Parameter<T> * param =
                           dynamic_cast<libMesh::Parameters::Parameter<T> *>(pair.second);
                       return param != nullptr;
                     });
}

connect()

void ControllableItem::connect	(	ControllableItem *	item,
		bool	type_check = true
	)

Connects the supplied item with this item to allow for multiple parameters to be changed by one.

Definition at line 24 of file ControllableItem.C.

Referenced by ControllableAlias::ControllableAlias().

{
  for (const auto & pair : item->_pairs)
  {
    if (type_check && type() != pair.second->type())
      mooseError("The master parameter (",
                 name(),
                 ") has a type '",
                 type(),
                 "' and cannot be connected to the parameter (",
                 pair.first,
                 ") with a different type of '",
                 pair.second->type(),
                 "'.");

    _pairs.emplace_back(pair.first, pair.second);
  }
}

dump()

std::string ControllableItem::dump ( unsigned int  indent = 0 ) const

virtual

Returns a string displaying the parameter name and current value.

Reimplemented in ControllableAlias.

Definition at line 44 of file ControllableItem.C.

Referenced by operator<<().

{

  // Count of objects, for printing a number with the parameter
  unsigned int index = 0;

  std::ostringstream oss;
  for (const auto & pair : _pairs)
  {
    if (index == 0) // master parameter
      oss << ConsoleUtils::indent(indent) << COLOR_GREEN << pair.first << COLOR_DEFAULT << " = ";
    else // slave parameters
      oss << ConsoleUtils::indent(indent + 2) << COLOR_YELLOW << pair.first << COLOR_DEFAULT
          << " = ";

    pair.second->print(oss);
    oss << " <" << pair.second->type() << ">" << '\n';
    index++;
  }
  return oss.str();
}

get()

template<typename T >

std::vector< T > ControllableItem::get

(

bool

type_check = true

)

const

Return a copy of all values for this "item".

Definition at line 154 of file ControllableItem.h.

{
  std::vector<T> output;
  output.reserve(_pairs.size());
  for (const auto & pair : _pairs)
  {
    libMesh::Parameters::Parameter<T> * param =
        dynamic_cast<libMesh::Parameters::Parameter<T> *>(pair.second);
    if (type_check && param == nullptr)
      mooseError("Failed to get the '",
                 pair.first,
                 "' parameter the supplied template argument must be of type '",
                 pair.second->type(),
                 "'.");
    else if (param != nullptr)
      output.push_back(param->get());
  }
  return output;
}

getExecuteOnFlags()

const std::set<ExecFlagType>& ControllableItem::getExecuteOnFlags ( ) const

inline

Return the execute flag restrictions, an empty set is un-restricted.

Definition at line 109 of file ControllableItem.h.

{ return _execute_flags; }

isChanged()

bool ControllableItem::isChanged ( )

inline

Definition at line 103 of file ControllableItem.h.

{ return _changed; }

name()

const MooseObjectParameterName & ControllableItem::name ( ) const

virtual

Return the name of the master parameter.

Reimplemented in ControllableAlias.

Definition at line 73 of file ControllableItem.C.

Referenced by connect(), ControllableItem(), operator!=(), operator<(), and operator==().

{
  return _pairs[0].first;
}

operator!=()

bool ControllableItem::operator!= ( const ControllableItem &  rhs ) const

inline

Definition at line 78 of file ControllableItem.h.

{ return name() != rhs.name(); }

operator<()

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

inline

Definition at line 79 of file ControllableItem.h.

{ return name() < rhs.name(); }

operator=() [1/2]

ControllableItem& ControllableItem::operator= ( const ControllableItem &  )

delete

operator=() [2/2]

ControllableItem& ControllableItem::operator= ( ControllableItem &&  )

delete

operator==()

bool ControllableItem::operator== ( const ControllableItem &  rhs ) const

inline

Use the master name for comparison operators to allow object to work within a set/map.

Definition at line 77 of file ControllableItem.h.

{ return name() == rhs.name(); }

resetChanged()

void ControllableItem::resetChanged ( )

inline

Methods for ControlOutput::outputChangedControls, these don't have meaning outside of this function.

Definition at line 102 of file ControllableItem.h.

{ _changed = false; }

set()

template<typename T >

void ControllableItem::set	(	const T &	value,
		bool	type_check = true
	)

Set the value(s) of the controlled parameters stored in this class.

The 'skip_type_check' flag allows this object to work with ControllableParameter that can store values of varying types.

Definition at line 132 of file ControllableItem.h.

{
  for (auto & pair : _pairs)
  {
    libMesh::Parameters::Parameter<T> * param =
        dynamic_cast<libMesh::Parameters::Parameter<T> *>(pair.second);
    if (type_check && param == nullptr)
      mooseError("Failed to set the '",
                 pair.first,
                 "' parameter the supplied template argument must be of type '",
                 pair.second->type(),
                 "'.");
    else if (param != nullptr)
    {
      param->set() = value;
      _changed = true;
    }
  }
}

type()

std::string ControllableItem::type

(

)

const

Return the type of the master parameter.

Definition at line 67 of file ControllableItem.C.

Referenced by connect().

{
  return _pairs[0].second->type();
}

Friends And Related Function Documentation

operator<<

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

friend

Allows this to be used with std:: cout.

Definition at line 106 of file ControllableItem.C.

{
  return stream << obj.dump();
}

Member Data Documentation

_changed

bool ControllableItem::_changed = false

protected

Flag for ControlOutput, allows output objects to keep track of when a parameter is altered.

Definition at line 124 of file ControllableItem.h.

Referenced by isChanged(), resetChanged(), and set().

_execute_flags

std::set<ExecFlagType> ControllableItem::_execute_flags

protected

Flags to which the control is restricted (if not set it is unrestricted)

Definition at line 127 of file ControllableItem.h.

Referenced by getExecuteOnFlags().

_pairs

std::vector<std::pair<MooseObjectParameterName, libMesh::Parameters::Value *> > ControllableItem::_pairs

protected

List of names for this item.

Definition at line 121 of file ControllableItem.h.

Referenced by check(), connect(), ControllableItem(), dump(), ControllableAlias::dump(), get(), name(), set(), and type().

---

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

• include/controls/ControllableItem.h
• src/controls/ControllableItem.C