AttribMatrixTags Class Reference

#include <Attributes.h>

Inheritance diagram for AttribMatrixTags:

Public Types
typedef unsigned int	Key

Public Member Functions
void	setFrom (Key k)
	AttribMatrixTags (TheWarehouse &w)
	AttribMatrixTags (TheWarehouse &w, TagID tag)
	AttribMatrixTags (TheWarehouse &w, const std::set< TagID > &tags)
virtual void	initFrom (const MooseObject *obj) override
	initFrom reads and stores the desired meta-data from obj for later matching comparisons. More...
	clonefunc (AttribMatrixTags)
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. More...
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. More...
	hashfunc (_vals)
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. More...
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. More...
virtual std::unique_ptr< Attribute >	clone () const =0
	clone creates and returns and identical (deep) copy of this attribute - i.e. More...

Protected Attributes
std::vector< TagID >	_vals

Detailed Description

Definition at line 90 of file Attributes.h.

Member Typedef Documentation

Key

typedef unsigned int AttribMatrixTags::Key

Definition at line 93 of file Attributes.h.

Constructor & Destructor Documentation

AttribMatrixTags() [1/3]

AttribMatrixTags::AttribMatrixTags ( TheWarehouse &  w )

inline

Definition at line 100 of file Attributes.h.

: AttribTagBase(w, "matrix_tags") {}

AttribMatrixTags() [2/3]

AttribMatrixTags::AttribMatrixTags ( TheWarehouse &  w, TagID  tag  )

inline

Definition at line 101 of file Attributes.h.

: AttribTagBase(w, tag, "matrix_tags") {}

AttribMatrixTags() [3/3]

AttribMatrixTags::AttribMatrixTags ( TheWarehouse &  w, const std::set< TagID > &  tags  )

inline

Definition at line 102 of file Attributes.h.

    : AttribTagBase(w, tags, "matrix_tags")
  {
  }

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()

AttribMatrixTags::clonefunc

(

AttribMatrixTags

)

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()

AttribTagBase::hashfunc ( _vals  )

inherited

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 67 of file TheWarehouse.h.

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

{ return _id; }

initFrom()

void AttribMatrixTags::initFrom ( const MooseObject *  obj )

overridevirtual

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

Implements Attribute.

Definition at line 106 of file Attributes.C.

{
  _vals.clear();
  auto t = dynamic_cast<const TaggingInterface *>(obj);
  if (t)
  {
    for (auto & tag : t->getMatrixTags({}))
      _vals.push_back(static_cast<int>(tag));
  }
}

isEqual()

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

overridevirtualinherited

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 93 of file Attributes.C.

{
  auto a = dynamic_cast<const AttribTagBase *>(&other);
  if (!a || a->_vals.size() != _vals.size())
    return false;

  for (size_t i = 0; i < a->_vals.size(); i++)
    if (a->_vals[i] != _vals[i])
      return false;
  return true;
}

isMatch()

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

overridevirtualinherited

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 77 of file Attributes.C.

{
  auto a = dynamic_cast<const AttribTagBase *>(&other);
  if (!a)
    return false;
  if (a->_vals.size() == 0)
    return true; // the condition is empty tags - which we take to mean any tag should match

  // return true if any single tag matches between the two attribute objects
  for (auto val : _vals)
    if (std::find(a->_vals.begin(), a->_vals.end(), val) != a->_vals.end())
      return true;
  return false;
}

operator!=()

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

inlineinherited

Definition at line 62 of file TheWarehouse.h.

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

operator==()

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

inlineinherited

Definition at line 58 of file TheWarehouse.h.

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

setFrom()

void AttribMatrixTags::setFrom ( Key  k )

inline

Definition at line 94 of file Attributes.h.

  {
    _vals.clear();
    _vals.push_back(k);
  }

Member Data Documentation

_vals

std::vector<TagID> AttribTagBase::_vals

protectedinherited

Definition at line 87 of file Attributes.h.

Referenced by AttribTagBase::AttribTagBase(), initFrom(), AttribVectorTags::initFrom(), AttribTagBase::isEqual(), AttribTagBase::isMatch(), setFrom(), and AttribVectorTags::setFrom().

---

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

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