https://mooseframework.inl.gov
Public Member Functions | Public Attributes | List of all members
moose::internal::PerfGraphSectionInfo Class Reference

Used to hold metadata about the registered sections Note: this is a class instead of a struct because structs are not able to be created in place using emplace_back in C++11. More...

#include <PerfGraphRegistry.h>

Public Member Functions

 PerfGraphSectionInfo ()=default
 
 PerfGraphSectionInfo (const PerfID id, const std::string &name, const unsigned int level, const std::string &live_message, const bool print_dots)
 

Public Attributes

PerfID _id
 Unique ID. More...
 
std::string _name
 The name. More...
 
unsigned int _level
 Print level (verbosity level) More...
 
std::string _live_message
 Message to print while the section is running. More...
 
bool _print_dots
 Whether or not to print dots while this section runs. More...
 

Detailed Description

Used to hold metadata about the registered sections Note: this is a class instead of a struct because structs are not able to be created in place using emplace_back in C++11.

This will be fixed in C++20.

Definition at line 43 of file PerfGraphRegistry.h.

Constructor & Destructor Documentation

◆ PerfGraphSectionInfo() [1/2]

moose::internal::PerfGraphSectionInfo::PerfGraphSectionInfo ( )
default

◆ PerfGraphSectionInfo() [2/2]

moose::internal::PerfGraphSectionInfo::PerfGraphSectionInfo ( const PerfID  id,
const std::string &  name,
const unsigned int  level,
const std::string &  live_message,
const bool  print_dots 
)
inline

Definition at line 47 of file PerfGraphRegistry.h.

52  : _id(id), _name(name), _level(level), _live_message(live_message), _print_dots(print_dots)
53  {
54  }
std::string _live_message
Message to print while the section is running.
unsigned int _level
Print level (verbosity level)
bool _print_dots
Whether or not to print dots while this section runs.

Member Data Documentation

◆ _id

PerfID moose::internal::PerfGraphSectionInfo::_id

Unique ID.

Definition at line 57 of file PerfGraphRegistry.h.

◆ _level

unsigned int moose::internal::PerfGraphSectionInfo::_level

Print level (verbosity level)

Definition at line 63 of file PerfGraphRegistry.h.

Referenced by to_json().

◆ _live_message

std::string moose::internal::PerfGraphSectionInfo::_live_message

Message to print while the section is running.

Definition at line 66 of file PerfGraphRegistry.h.

Referenced by PerfGraphLivePrint::printStats(), and PerfGraph::push().

◆ _name

std::string moose::internal::PerfGraphSectionInfo::_name

The name.

Definition at line 60 of file PerfGraphRegistry.h.

Referenced by PerfGraph::printHeaviestSections().

◆ _print_dots

bool moose::internal::PerfGraphSectionInfo::_print_dots

Whether or not to print dots while this section runs.

Definition at line 69 of file PerfGraphRegistry.h.

Referenced by PerfGraphLivePrint::inSamePlace(), and PerfGraphLivePrint::printStats().


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