vg
tools for working with variation graphs
Loading...
Searching...
No Matches
handlegraph::PathForEachSocket Class Reference

#include <path_handle_graph.hpp>

Classes

class  iterator

Public Member Functions

iterator begin () const
iterator end () const
 ~PathForEachSocket ()=default

Private Member Functions

 PathForEachSocket ()=delete
 PathForEachSocket (const PathHandleGraph *graph, const path_handle_t &path)

Private Attributes

const PathHandleGraph * graph
 The graph that contains the path.
const path_handle_t path
 The path we're iterating over.

Friends

class PathHandleGraph

Detailed Description

An auxilliary class that enables for each loops over paths. Not intended to constructed directly. Instead, use the PathHandleGraph's scan_path method.

Constructor & Destructor Documentation

◆ ~PathForEachSocket()

handlegraph::PathForEachSocket::~PathForEachSocket ( )
default

◆ PathForEachSocket() [1/2]

handlegraph::PathForEachSocket::PathForEachSocket ( )
privatedelete

◆ PathForEachSocket() [2/2]

handlegraph::PathForEachSocket::PathForEachSocket ( const PathHandleGraph * graph,
const path_handle_t & path )
private

Member Function Documentation

◆ begin()

PathForEachSocket::iterator handlegraph::PathForEachSocket::begin ( ) const

◆ end()

PathForEachSocket::iterator handlegraph::PathForEachSocket::end ( ) const

◆ PathHandleGraph

friend class PathHandleGraph
friend

Member Data Documentation

◆ graph

const PathHandleGraph* handlegraph::PathForEachSocket::graph
private

The graph that contains the path.

◆ path

const path_handle_t handlegraph::PathForEachSocket::path
private

The path we're iterating over.


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