VectorPostprocessorReporterName Class Reference

A ReporterName that represents a VectorPostprocessor. More...

#include <ReporterName.h>

Inheritance diagram for VectorPostprocessorReporterName:

Public Member Functions
	VectorPostprocessorReporterName (const VectorPostprocessorName &name, const std::string &vector_name)
const std::string &	getObjectName () const
	Return the object name that produces the Reporter value. More...
const std::string &	getValueName () const
	Return the data name for the Reporter value. More...
const std::string	getCombinedName () const
	Return the name of the object and data as object_name/data_name. More...
std::string	getRestartableName () const
	Return the name used for registration of this Reporter in the restartable data system. More...
	operator std::string () const
	std::string operator allows this object to behave as a std::sting object More...
bool	operator== (const ReporterName &rhs) const
	Compare with another object or string. More...
bool	operator== (const std::string &combined_name) const
bool	operator< (const ReporterName &rhs) const
	Less than operator. More...
std::string	specialTypeToName () const
	Converts the special type to a usable name for error reporting. More...
bool	isPostprocessor () const
bool	isVectorPostprocessor () const
void	setIsPostprocessor ()
	Sets the special type to a Postprocessor. More...
void	setIsVectorPostprocessor ()
	Sets the special type to a VectorPostprocessor. More...
bool	empty () const
	Whether or not the ReporterName is empty, similar to std::string::empty() More...

Static Public Attributes
static const std::string	REPORTER_RESTARTABLE_DATA_PREFIX = "ReporterData"
	The prefix for reporter data in the restartable system. More...

Detailed Description

A ReporterName that represents a VectorPostprocessor.

Definition at line 143 of file ReporterName.h.

Constructor & Destructor Documentation

VectorPostprocessorReporterName()

VectorPostprocessorReporterName::VectorPostprocessorReporterName	(	const VectorPostprocessorName &	name,
		const std::string &	vector_name
	)

Definition at line 105 of file ReporterName.C.

  : ReporterName(name, vector_name)
{
  setIsVectorPostprocessor();
}

Member Function Documentation

empty()

bool ReporterName::empty ( ) const

inlineinherited

Whether or not the ReporterName is empty, similar to std::string::empty()

Definition at line 107 of file ReporterName.h.

{ return _object_name.empty() || _value_name.empty(); }

getCombinedName()

const std::string ReporterName::getCombinedName ( ) const

inherited

Return the name of the object and data as object_name/data_name.

Definition at line 47 of file ReporterName.C.

Referenced by ReporterData::getAllRealReporterFullNames(), ReporterData::getAllRealReporterValues(), ReporterName::getRestartableName(), ReporterTransferInterface::hideVariableHelper(), ReporterName::operator<(), operator<<(), and ReporterName::operator==().

{
  return _object_name + "/" + _value_name;
}

getObjectName()

const std::string & ReporterName::getObjectName ( ) const

inherited

Return the object name that produces the Reporter value.

Definition at line 35 of file ReporterName.C.

Referenced by CommonOutputAction::act(), UserObject::addReporterDependencyHelper(), AccumulateReporter::declareAccumulateHelper(), ReporterTransferInterface::hideVariableHelper(), TableOutput::outputReporters(), and Exodus::outputReporters().

{
  return _object_name;
}

getRestartableName()

std::string ReporterName::getRestartableName ( ) const

inherited

Return the name used for registration of this Reporter in the restartable data system.

Definition at line 53 of file ReporterName.C.

{
  return REPORTER_RESTARTABLE_DATA_PREFIX + "/" + getCombinedName();
}

getValueName()

const std::string & ReporterName::getValueName ( ) const

inherited

Return the data name for the Reporter value.

Definition at line 41 of file ReporterName.C.

Referenced by AccumulateReporter::declareAccumulateHelper(), ReporterData::getReporterStateHelper(), and Exodus::outputReporters().

{
  return _value_name;
}

isPostprocessor()

bool ReporterName::isPostprocessor ( ) const

inlineinherited

Returns

True if this ReporterName represents a Postprocessor

Definition at line 85 of file ReporterName.h.

Referenced by ReporterData::getReporterStateHelper(), and ReporterName::specialTypeToName().

{ return _special_type == SpecialType::POSTPROCESSOR; }

isVectorPostprocessor()

bool ReporterName::isVectorPostprocessor ( ) const

inlineinherited

Returns

True if this ReporterName represents a VectorPostprocessor

Definition at line 89 of file ReporterName.h.

Referenced by ReporterData::getReporterStateHelper(), and ReporterName::specialTypeToName().

{ return _special_type == SpecialType::VECTORPOSTPROCESSOR; }

operator std::string()

ReporterName::operator std::string ( ) const

inherited

std::string operator allows this object to behave as a std::sting object

Definition at line 58 of file ReporterName.C.

{ return getCombinedName(); }

operator<()

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

inherited

Less than operator.

Definition at line 75 of file ReporterName.C.

{
  // Note here that we do not sort by _special_type. This is because
  // we want to store reporter names as a single name regardless of the type
  return getCombinedName() < rhs.getCombinedName();
}

operator==() [1/2]

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

inherited

Compare with another object or string.

Definition at line 61 of file ReporterName.C.

{
  // Note here that we do not check if _special_type is the same. This is because
  // we want to store reporter names as a single name regardless of the type
  return _object_name == rhs._object_name && _value_name == rhs._value_name;
}

operator==() [2/2]

bool ReporterName::operator== ( const std::string &  combined_name ) const

inherited

Definition at line 69 of file ReporterName.C.

{
  return getCombinedName() == combined_name;
}

setIsPostprocessor()

void ReporterName::setIsPostprocessor ( )

inlineinherited

Sets the special type to a Postprocessor.

See ReporterData::declareReporterValue.

Definition at line 96 of file ReporterName.h.

Referenced by PostprocessorReporterName::PostprocessorReporterName(), and ReporterStateBase::setIsPostprocessor().

{ _special_type = SpecialType::POSTPROCESSOR; }

setIsVectorPostprocessor()

void ReporterName::setIsVectorPostprocessor ( )

inlineinherited

Sets the special type to a VectorPostprocessor.

See ReporterData::declareReporterValue.

Definition at line 102 of file ReporterName.h.

Referenced by ReporterStateBase::setIsVectorPostprocessor(), and VectorPostprocessorReporterName().

{ _special_type = SpecialType::VECTORPOSTPROCESSOR; }

specialTypeToName()

std::string ReporterName::specialTypeToName ( ) const

inherited

Converts the special type to a usable name for error reporting.

Definition at line 83 of file ReporterName.C.

Referenced by ReporterData::getReporterStateHelper().

{
  if (isPostprocessor())
    return "Postprocessor";
  if (isVectorPostprocessor())
    return "VectorPostprocessor";
  return "Reporter";
}

Member Data Documentation

REPORTER_RESTARTABLE_DATA_PREFIX

const std::string ReporterName::REPORTER_RESTARTABLE_DATA_PREFIX = "ReporterData"

staticinherited

The prefix for reporter data in the restartable system.

Definition at line 54 of file ReporterName.h.

Referenced by RestartableDataReporter::execute(), and ReporterName::getRestartableName().

---

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

• include/reporters/ReporterName.h
• src/reporters/ReporterName.C