Libmagicxx v9.0.2
A C++ wrapper library over the Magic Number Recognition Library.
Loading...
Searching...
No Matches
recognition::utility::advance_tracker Class Reference

RAII helper that advances a shared progress_tracker by a given step count upon destruction. More...

#include <progress_tracker.hpp>

Public Member Functions

 advance_tracker (shared_progress_tracker_t shared_tracker, std::uint64_t step_count=1u) noexcept
 Construct advance_tracker with a shared tracker and step count.
 
 ~advance_tracker ()
 Advance the tracker by the step count if it exists.
 

Private Attributes

shared_progress_tracker_t m_shared_tracker
 
std::uint64_t m_step_count
 

Detailed Description

RAII helper that advances a shared progress_tracker by a given step count upon destruction.

Constructor & Destructor Documentation

◆ advance_tracker()

recognition::utility::advance_tracker::advance_tracker ( shared_progress_tracker_t shared_tracker,
std::uint64_t step_count = 1u )
inlineexplicitnoexcept

Construct advance_tracker with a shared tracker and step count.

Parameters
shared_trackerThe shared tracker to advance.
step_countNumber of steps to advance (default: 1).

◆ ~advance_tracker()

recognition::utility::advance_tracker::~advance_tracker ( )
inline

Advance the tracker by the step count if it exists.

Member Data Documentation

◆ m_shared_tracker

shared_progress_tracker_t recognition::utility::advance_tracker::m_shared_tracker
private

◆ m_step_count

std::uint64_t recognition::utility::advance_tracker::m_step_count
private

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