vg::AlignmentValidity Struct Reference

#include <alignment.hpp>

Public Types
enum	Problem { OK, NODE_MISSING, NODE_TOO_SHORT, SEQ_DOES_NOT_MATCH }
	The different kinds of possible problems with alignments. More...

Public Member Functions
	operator bool () const
	We are truthy if the alignment has no problem, and falsey otherwise. More...

Public Attributes
Problem	problem = OK
	The kind of problem with the alignment. More...
size_t	bad_mapping_index = 0
	The mapping in the alignment's path at which the problem was encountered. More...
std::string	message = ""
	An explanation for the problem. More...

Detailed Description

Represents a report on whether an alignment makes sense in the context of a graph.

Member Enumeration Documentation

Problem

enum vg::AlignmentValidity::Problem

The different kinds of possible problems with alignments.

Enumerator
OK
NODE_MISSING
NODE_TOO_SHORT
SEQ_DOES_NOT_MATCH

Member Function Documentation

operator bool()

vg::AlignmentValidity::operator bool ( ) const

inline

We are truthy if the alignment has no problem, and falsey otherwise.

Member Data Documentation

bad_mapping_index

size_t vg::AlignmentValidity::bad_mapping_index = 0

The mapping in the alignment's path at which the problem was encountered.

message

std::string vg::AlignmentValidity::message = ""

An explanation for the problem.

problem

Problem vg::AlignmentValidity::problem = OK

The kind of problem with the alignment.

---

The documentation for this struct was generated from the following file:

• src/alignment.hpp