#include <explainer.hpp>
Inheritance diagram for vg::SubgraphExplainer:
Public Member Functions | |
| SubgraphExplainer (bool enabled) | |
| Construct an explainer that will save a single graph. More... | |
| void | subgraph (const HandleGraph &graph) |
| Write out a subgraph. 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
Explainer that can dump a handle graph.
Constructor & Destructor Documentation
◆ SubgraphExplainer()
| vg::SubgraphExplainer::SubgraphExplainer | ( | bool | enabled | ) |
Construct an explainer that will save a single graph.
Member Function Documentation
◆ subgraph()
| void vg::SubgraphExplainer::subgraph | ( | const HandleGraph & | graph | ) |
Write out a subgraph.
The documentation for this class was generated from the following files:
- src/explainer.hpp
- src/explainer.cpp
