ReporterStateBase Class Reference

The base class for storing a Reporter's state. More...

#include <ReporterState.h>

Inheritance diagram for ReporterStateBase:

Public Member Functions
	ReporterStateBase (const ReporterName &name)
virtual	~ReporterStateBase ()=default
const ReporterName &	getReporterName () const
	Return the ReporterName that this state is associated with. More...
void	addConsumer (ReporterMode mode, const MooseObject &moose_object)
	Add a consumer for this ReporterState. More...
const std::set< std::pair< ReporterMode, const MooseObject * > > &	getConsumers () const
	Returns the consumers for this state; a pair that consists of the mode that the state is being consumed by, and the object consuming it. More...
virtual std::string	valueType () const =0
void	setIsPostprocessor ()
	Sets the special Reporter type to a Postprocessor. More...
void	setIsVectorPostprocessor ()
	Sets the special Reporter type to a VectorPostprocessor. More...

Private Attributes
ReporterName	_reporter_name
	Name of data that state is associated. More...
std::set< std::pair< ReporterMode, const MooseObject * > >	_consumers
	The consumers for this state; we store the MooseObject for detailed error reporting. More...

Detailed Description

The base class for storing a Reporter's state.

The base class is needed in order to store the states without a template parameter so that they can be iterated through to observe the producers and consumers.

Definition at line 32 of file ReporterState.h.

Constructor & Destructor Documentation

ReporterStateBase()

ReporterStateBase::ReporterStateBase

(

const ReporterName &

name

)

Definition at line 14 of file ReporterState.C.

: _reporter_name(name) {}

~ReporterStateBase()

virtual ReporterStateBase::~ReporterStateBase ( )

virtualdefault

Member Function Documentation

addConsumer()

void ReporterStateBase::addConsumer	(	ReporterMode	mode,
		const MooseObject &	moose_object
	)

Add a consumer for this ReporterState.

Parameters

mode	The mode that the object will consume the Reporter value
moose_object	The MooseObject doing the consuming (for error reporting)

See also

ReporterData

Definition at line 17 of file ReporterState.C.

Referenced by ReporterTransferInterface::addReporterTransferMode().

{
  _consumers.emplace(mode, &moose_object);
}

getConsumers()

const std::set<std::pair<ReporterMode, const MooseObject *> >& ReporterStateBase::getConsumers ( ) const

inline

Returns the consumers for this state; a pair that consists of the mode that the state is being consumed by, and the object consuming it.

See also

ReporterContext

Definition at line 56 of file ReporterState.h.

Referenced by ReporterData::getReporterInfo(), and ReporterContextBase::requiresConsumerModes().

  {
    return _consumers;
  }

getReporterName()

const ReporterName& ReporterStateBase::getReporterName ( ) const

inline

Return the ReporterName that this state is associated with.

Definition at line 41 of file ReporterState.h.

Referenced by ReporterData::getReporterInfo().

{ return _reporter_name; }

setIsPostprocessor()

void ReporterStateBase::setIsPostprocessor ( )

inline

Sets the special Reporter type to a Postprocessor.

See ReporterData::declareReporterValue.

Definition at line 71 of file ReporterState.h.

{ _reporter_name.setIsPostprocessor(); }

setIsVectorPostprocessor()

void ReporterStateBase::setIsVectorPostprocessor ( )

inline

Sets the special Reporter type to a VectorPostprocessor.

See ReporterData::declareReporterValue.

Definition at line 77 of file ReporterState.h.

{ _reporter_name.setIsVectorPostprocessor(); }

valueType()

virtual std::string ReporterStateBase::valueType ( ) const

pure virtual

Returns

The type associated with this state

Implemented in ReporterState< T >, and ReporterState< std::vector< T > >.

Referenced by ReporterData::getReporterInfo().

Member Data Documentation

_consumers

std::set<std::pair<ReporterMode, const MooseObject *> > ReporterStateBase::_consumers

private

The consumers for this state; we store the MooseObject for detailed error reporting.

Definition at line 84 of file ReporterState.h.

Referenced by addConsumer(), and getConsumers().

_reporter_name

ReporterName ReporterStateBase::_reporter_name

private

Name of data that state is associated.

Definition at line 81 of file ReporterState.h.

Referenced by getReporterName(), setIsPostprocessor(), and setIsVectorPostprocessor().

---

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

• include/reporters/ReporterState.h
• src/interfaces/ReporterState.C