Shamrock 2025.10.0
Astrophysical Code
Loading...
Searching...
No Matches
shambase::details::NamedBasicStackEntry Struct Reference
Collaboration diagram for shambase::details::NamedBasicStackEntry:

Public Member Functions

 NamedBasicStackEntry (std::string name, bool do_timer=true, SourceLocation &&loc=SourceLocation{})
 Construct a new Named Basic Stack Entry object.
 ~NamedBasicStackEntry ()
 Destroy the Named Basic Stack Entry object.

Public Attributes

SourceLocation loc
 Source location attached to the entry.
bool do_timer
 is the timer enabled for this entry
std::string name
 Name of the entry.
f64 wtime_start
 start time of the entry
CallStackEntry scoped_callstack_entry
 scoped call stack entry

Detailed Description

Definition at line 170 of file stacktrace.hpp.

Constructor & Destructor Documentation

◆ NamedBasicStackEntry()

shambase::details::NamedBasicStackEntry::NamedBasicStackEntry ( std::string name,
bool do_timer = true,
SourceLocation && loc = SourceLocation{} )
inline

Construct a new Named Basic Stack Entry object.

Parameters
nameName of the entry
do_timerIs the timer enabled for this entry (default: true)
locSource location attached to the entry (default: SourceLocation{})

Definition at line 188 of file stacktrace.hpp.

◆ ~NamedBasicStackEntry()

shambase::details::NamedBasicStackEntry::~NamedBasicStackEntry ( )
inline

Destroy the Named Basic Stack Entry object.

Pop the name from the call stack and stop the timer if enabled

Definition at line 206 of file stacktrace.hpp.

Member Data Documentation

◆ do_timer

bool shambase::details::NamedBasicStackEntry::do_timer

is the timer enabled for this entry

Definition at line 172 of file stacktrace.hpp.

◆ loc

SourceLocation shambase::details::NamedBasicStackEntry::loc

Source location attached to the entry.

Definition at line 171 of file stacktrace.hpp.

◆ name

std::string shambase::details::NamedBasicStackEntry::name

Name of the entry.

Definition at line 173 of file stacktrace.hpp.

◆ scoped_callstack_entry

CallStackEntry shambase::details::NamedBasicStackEntry::scoped_callstack_entry

scoped call stack entry

Definition at line 179 of file stacktrace.hpp.

◆ wtime_start

f64 shambase::details::NamedBasicStackEntry::wtime_start

start time of the entry

Definition at line 176 of file stacktrace.hpp.


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