vg::Explainer Class Reference

#include <explainer.hpp>

Inheritance diagram for vg::Explainer:

Public Member Functions
	Explainer ()
	Construct an Explainer that will save to one or more files.
virtual	~Explainer ()
	Close out the files being explained to.

Static Public Attributes
static bool	save_explanations = false
	Determine if explanations should be generated.

Protected Attributes
size_t	explanation_number
	What number explanation are we? Distinguishes different objects.

Static Protected Attributes
static std::atomic< size_t >	next_explanation_number {0}
	Counter used to give different explanations their own unique filenames.

Detailed Description

Base explainer class. Handles making sure each explanation has a different unique number.

Constructor & Destructor Documentation

Explainer()

vg::Explainer::Explainer

(

)

Construct an Explainer that will save to one or more files.

~Explainer()

vg::Explainer::~Explainer ( )

virtual

Close out the files being explained to.

Member Data Documentation

explanation_number

size_t vg::Explainer::explanation_number

protected

What number explanation are we? Distinguishes different objects.

next_explanation_number

std::atomic< size_t > vg::Explainer::next_explanation_number {0}

staticprotected

Counter used to give different explanations their own unique filenames.

save_explanations

bool vg::Explainer::save_explanations = false

static

Determine if explanations should be generated.

---

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

• src/explainer.hpp
• src/explainer.cpp