vt::runtime::component::detail::DiagnosticBase struct
#include <src/vt/runtime/component/diagnostic_value_base.h>

Base class for a diagnostic value with type of actual value erased.

Derived classes

template<typename T>
struct DiagnosticValue
A keyed diagnostic value of some type T.
template<typename T>
struct DiagnosticValue
A keyed diagnostic value of some type T.
template<typename T>
struct DiagnosticValue
A keyed diagnostic value of some type T.
template<typename T>
struct DiagnosticValue
A keyed diagnostic value of some type T.
template<typename T>
struct DiagnosticValue
A keyed diagnostic value of some type T.

Constructors, destructors, conversion operators

magistrate_virtual_serialize_root() DiagnosticBase(std
Construct a new diagnostic base value.
~DiagnosticBase() virtual

Public functions

auto getKey() const -> std::string const &
Get the diagnostic value key.
auto getDescription() const -> std::string const &
Get the description of the diagnostic value.
auto getType() const -> DiagnosticTypeEnum
Get the type of diagnostic value.
auto getUpdateType() const -> DiagnosticUpdate
Get the type of diagnostic update.
auto getUnit() const -> DiagnosticUnit
Get the type of unit for this value.
void reduceOver(Diagnostic* diagnostic, DiagnosticErasedValue* out, int snapshot) pure virtual
Reduce over this value to compute stats over all the nodes for this particular diagnostic value.
template<typename SerializerT>
void serialize(SerializerT& s)

Protected variables

const DiagnosticTypeEnum type_
const DiagnosticUpdate update_
const DiagnosticUnit unit_
const std::string key_
const std::string desc_

Function documentation

std::string const & vt::runtime::component::detail::DiagnosticBase::getKey() const

Get the diagnostic value key.

Returns the key

std::string const & vt::runtime::component::detail::DiagnosticBase::getDescription() const

Get the description of the diagnostic value.

Returns the description

DiagnosticTypeEnum vt::runtime::component::detail::DiagnosticBase::getType() const

Get the type of diagnostic value.

Returns the type of diagnostic

DiagnosticUpdate vt::runtime::component::detail::DiagnosticBase::getUpdateType() const

Get the type of diagnostic update.

Returns the type of diagnostic update

DiagnosticUnit vt::runtime::component::detail::DiagnosticBase::getUnit() const

Get the type of unit for this value.

Returns the type of diagnostic unit

void vt::runtime::component::detail::DiagnosticBase::reduceOver(Diagnostic* diagnostic, DiagnosticErasedValue* out, int snapshot) pure virtual

Reduce over this value to compute stats over all the nodes for this particular diagnostic value.

Parameters
diagnostic in the component with the Diagnostic trait to reduce
out in type-erased values output from reduction over all nodes
snapshot in the time snapshot to reduce over (0 is entire runtime)

Variable documentation

const DiagnosticTypeEnum vt::runtime::component::detail::DiagnosticBase::type_ protected

The diagnostic type

const DiagnosticUpdate vt::runtime::component::detail::DiagnosticBase::update_ protected

The diagnostic value update type

const DiagnosticUnit vt::runtime::component::detail::DiagnosticBase::unit_ protected

The diagnostic unit type for this value

const std::string vt::runtime::component::detail::DiagnosticBase::key_ protected

Key for looking up the value

const std::string vt::runtime::component::detail::DiagnosticBase::desc_ protected

Long description of the value