#include <explainer.hpp>
Inheritance diagram for vg::DotDumpExplainer< T >:
Public Member Functions | |
| DotDumpExplainer (bool enabled, const T &to_dump) | |
| Construct a DotDumpExplainer that will save a diagram to a file. More... | |
 Public Member Functions inherited from vg::Explainer | |
| Explainer (bool enabled) | |
| Construct an Explainer that will save to one or more files. More... | |
| virtual | ~Explainer () |
| Close out the files being explained to. More... | |
| operator bool () const | |
Additional Inherited Members | |
| Static Public Member Functions inherited from vg::Explainer | |
| static void | set_context (const std::string &context) |
| static void | clear_context () |
| Clear the current per-thread context. More... | |
| Static Public Attributes inherited from vg::Explainer | |
| static bool | save_explanations = false |
| Protected Member Functions inherited from vg::Explainer | |
| bool | explaining () const |
| Function to check if we should be explaining. More... | |
| Static Protected Member Functions inherited from vg::Explainer | |
| static size_t | get_new_explanation_number () |
| static std::string | make_filename (const std::string &base_name, const std::string &extension) |
| Protected Attributes inherited from vg::Explainer | |
| size_t | explanation_number |
| What number explanation are we? Distinguishes different objects. More... | |
| bool | enabled |
| Determines if this explainer should generate explanations. More... | |
| Static Protected Attributes inherited from vg::Explainer | |
| static std::atomic< size_t > | next_explanation_number {0} |
| Counter used to give different explanations their own unique filenames. More... | |
| static thread_local size_t | next_context_explanation_number {0} |
| static thread_local std::string | current_context = "" |
| Current thing (possibly a read name) being explained (for organizing into directories) More... | |
Detailed Description
template<typename T>
class vg::DotDumpExplainer< T >
Explainer that can dump anything that has a: void to_dot(ostream& out) const; method, such as a Funnel.
Constructor & Destructor Documentation
◆ DotDumpExplainer()
template<typename T >
| vg::DotDumpExplainer< T >::DotDumpExplainer | ( | bool | enabled, |
| const T & | to_dump | ||
| ) |
Construct a DotDumpExplainer that will save a diagram to a file.
The documentation for this class was generated from the following file:
- src/explainer.hpp
