AttribExecutionOrderGroup Class Reference

#include <Attributes.h>

Inheritance diagram for AttribExecutionOrderGroup:

Public Types
typedef int	Key

Public Member Functions
void	setFrom (Key k)
	AttribExecutionOrderGroup (TheWarehouse &w)
	AttribExecutionOrderGroup (TheWarehouse &w, Key p)
virtual void	initFrom (const MooseObject *obj) override
	initFrom reads and stores the desired meta-data from obj for later matching comparisons.
virtual bool	isMatch (const Attribute &other) const override
	isMatch returns true if the meta-data stored in this attribute is equivalent to that stored in other.
virtual bool	isEqual (const Attribute &other) const override
	isEqual returns true if the meta-data stored in this attribute is identical to that stored in other.
	hashfunc (_val)
	clonefunc (AttribExecutionOrderGroup)
bool	operator== (const Attribute &other) const
bool	operator!= (const Attribute &other) const
unsigned int	id () const
	returns the unique attribute ID associated with all attributes that have the same (mose derived) class as this object.
virtual std::size_t	hash () const =0
	This function must return a deterministic value that is uniquely determined by the data the attribute holds (i.e.
virtual std::unique_ptr< Attribute >	clone () const =0
	clone creates and returns and identical (deep) copy of this attribute - i.e.

Private Attributes
int	_val = 0
int	_id = -1

Detailed Description

Definition at line 252 of file Attributes.h.

Member Typedef Documentation

Key

typedef int AttribExecutionOrderGroup::Key

Definition at line 255 of file Attributes.h.

Constructor & Destructor Documentation

AttribExecutionOrderGroup() [1/2]

AttribExecutionOrderGroup::AttribExecutionOrderGroup ( TheWarehouse &  w )

inline

Definition at line 258 of file Attributes.h.

: Attribute(w, "execution_order_group") {}

AttribExecutionOrderGroup() [2/2]

AttribExecutionOrderGroup::AttribExecutionOrderGroup ( TheWarehouse &  w, Key  p  )

inline

Definition at line 259 of file Attributes.h.

    : Attribute(w, "execution_order_group"), _val(p)
  {
  }

Member Function Documentation

clone()

virtual std::unique_ptr< Attribute > Attribute::clone ( ) const

pure virtualinherited

clone creates and returns and identical (deep) copy of this attribute - i.e.

the result of clone should return true if passed into isMatch.

Referenced by TheWarehouse::update().

clonefunc()

AttribExecutionOrderGroup::clonefunc

(

AttribExecutionOrderGroup

)

hash()

virtual std::size_t Attribute::hash ( ) const

pure virtualinherited

This function must return a deterministic value that is uniquely determined by the data the attribute holds (i.e.

is initialized with). Ideally, the data should be uniformly and randomly distributed across the domain of size_t values - e.g. 1 and 2 should hash to completely unrelated values. Use of std::hash for POD is encouraged. A convenience hash_combine function is also provided to combine the results an existing hash with one or more other values.

Referenced by std::hash< Attribute >::operator()().

hashfunc()

AttribExecutionOrderGroup::hashfunc

(

_val

)

id()

unsigned int Attribute::id ( ) const

inlineinherited

returns the unique attribute ID associated with all attributes that have the same (mose derived) class as this object.

This ID is determined at construction time this

Definition at line 68 of file TheWarehouse.h.

{ return _id; }

Referenced by std::hash< Attribute >::operator()().

initFrom()

void AttribExecutionOrderGroup::initFrom ( const MooseObject *  obj )

overridevirtual

initFrom reads and stores the desired meta-data from obj for later matching comparisons.

Implements Attribute.

Definition at line 287 of file Attributes.C.

{
  const auto * uo = dynamic_cast<const UserObjectBase *>(obj);
  _val = uo ? uo->getParam<int>("execution_order_group") : 0;
}

isEqual()

bool AttribExecutionOrderGroup::isEqual ( const Attribute &  other ) const

overridevirtual

isEqual returns true if the meta-data stored in this attribute is identical to that stored in other.

isEqual does not need to check/compare the values from the instances' id() functions.

Implements Attribute.

Definition at line 299 of file Attributes.C.

{
  return isMatch(other);
}

isMatch()

bool AttribExecutionOrderGroup::isMatch ( const Attribute &  other ) const

overridevirtual

isMatch returns true if the meta-data stored in this attribute is equivalent to that stored in other.

This is is for query matching - not exact equivalence. isMatch does not need to check/compare the values from the instances' id() functions.

Implements Attribute.

Definition at line 293 of file Attributes.C.

{
  auto a = dynamic_cast<const AttribExecutionOrderGroup *>(&other);
  return a && (a->_val == _val);
}

Referenced by isEqual().

operator!=()

bool Attribute::operator!= ( const Attribute &  other ) const

inlineinherited

Definition at line 63 of file TheWarehouse.h.

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

operator==()

bool Attribute::operator== ( const Attribute &  other ) const

inlineinherited

Definition at line 59 of file TheWarehouse.h.

  {
    return _id == other._id && isEqual(other);
  }

setFrom()

void AttribExecutionOrderGroup::setFrom ( Key  k )

inline

Definition at line 256 of file Attributes.h.

{ _val = k; }

Member Data Documentation

_id

int Attribute::_id = -1

privateinherited

Definition at line 93 of file TheWarehouse.h.

Referenced by Attribute::id(), and Attribute::operator==().

_val

int AttribExecutionOrderGroup::_val = 0

private

Definition at line 270 of file Attributes.h.

Referenced by initFrom(), isMatch(), and setFrom().

---

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

• include/base/Attributes.h
• src/base/Attributes.C