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

#include <path_handle_graph.hpp>

Public Member Functions

 iterator (const iterator &other)=default
iterator & operator= (const iterator &other)=default
iterator & operator++ ()
handle_t operator* () const
bool operator== (const iterator &other) const
bool operator!= (const iterator &other) const
 ~iterator ()=default

Private Member Functions

 iterator ()=delete
 iterator (const step_handle_t &step, bool force_unequal, const PathHandleGraph *graph)

Private Attributes

step_handle_t step
 the step that this iterator points to
bool force_unequal
const PathHandleGraph * graph
 the graph that contains the path

Friends

class PathForEachSocket

Detailed Description

Iterator object over path

Constructor & Destructor Documentation

◆ iterator() [1/3]

handlegraph::PathForEachSocket::iterator::iterator ( const iterator & other)
default

◆ ~iterator()

handlegraph::PathForEachSocket::iterator::~iterator ( )
default

◆ iterator() [2/3]

handlegraph::PathForEachSocket::iterator::iterator ( )
privatedelete

◆ iterator() [3/3]

handlegraph::PathForEachSocket::iterator::iterator ( const step_handle_t & step,
bool force_unequal,
const PathHandleGraph * graph )
private

Member Function Documentation

◆ operator!=()

bool handlegraph::PathForEachSocket::iterator::operator!= ( const iterator & other) const

◆ operator*()

handle_t handlegraph::PathForEachSocket::iterator::operator* ( ) const

◆ operator++()

PathForEachSocket::iterator & handlegraph::PathForEachSocket::iterator::operator++ ( )

◆ operator=()

iterator & handlegraph::PathForEachSocket::iterator::operator= ( const iterator & other)
default

◆ operator==()

bool handlegraph::PathForEachSocket::iterator::operator== ( const iterator & other) const

◆ PathForEachSocket

friend class PathForEachSocket
friend

Member Data Documentation

◆ force_unequal

bool handlegraph::PathForEachSocket::iterator::force_unequal
private

a bit of an ugly hack we need to handle the fact that the first iteration of a circular path is also the place where we will end

◆ graph

const PathHandleGraph* handlegraph::PathForEachSocket::iterator::graph
private

the graph that contains the path

◆ step

step_handle_t handlegraph::PathForEachSocket::iterator::step
private

the step that this iterator points to


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