vg
tools for working with variation graphs
Public Member Functions | List of all members
vg::SubgraphExplainer Class Reference

#include <explainer.hpp>

Inheritance diagram for vg::SubgraphExplainer:
vg::Explainer

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 Attributes inherited from vg::Explainer
static bool save_explanations = false
 Determine if explanations should be generated. More...
 
- Protected Member Functions inherited from vg::Explainer
bool explaining () const
 Function to check if we should be explaining. More...
 
- 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...
 

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: