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

#include <alignment_emitter.hpp>

Inheritance diagram for vg::io::NullAlignmentEmitter:
vg::io::AlignmentEmitter

Public Member Functions

virtual void emit_singles (vector< Alignment > &&aln_batch)
 Emit a batch of Alignments. More...
 
virtual void emit_mapped_singles (vector< vector< Alignment >> &&alns_batch)
 Emit batch of Alignments with secondaries. All secondaries must have is_secondary set already. More...
 
virtual void emit_pairs (vector< Alignment > &&aln1_batch, vector< Alignment > &&aln2_batch, vector< int64_t > &&tlen_limit_batch)
 
virtual void emit_mapped_pairs (vector< vector< Alignment >> &&alns1_batch, vector< vector< Alignment >> &&alns2_batch, vector< int64_t > &&tlen_limit_batch)
 
- Public Member Functions inherited from vg::io::AlignmentEmitter
virtual void emit_extra_message (const std::string &tag, std::string &&data)
 Emit some extra type-tagged data, if the backing format supports it. More...
 
virtual void emit_single (Alignment &&aln)
 Emit a single Alignment. More...
 
virtual void emit_mapped_single (vector< Alignment > &&alns)
 Emit a single Alignment with secondaries. All secondaries must have is_secondary set already. More...
 
virtual void emit_pair (Alignment &&aln1, Alignment &&aln2, int64_t tlen_limit=0)
 
virtual void emit_mapped_pair (vector< Alignment > &&alns1, vector< Alignment > &&alns2, int64_t tlen_limit=0)
 
virtual ~AlignmentEmitter ()=default
 Allow destruction through base class pointer. More...
 

Detailed Description

Discards all alignments.

Member Function Documentation

◆ emit_mapped_pairs()

virtual void vg::io::NullAlignmentEmitter::emit_mapped_pairs ( vector< vector< Alignment >> &&  alns1_batch,
vector< vector< Alignment >> &&  alns2_batch,
vector< int64_t > &&  tlen_limit_batch 
)
inlinevirtual

Emit the mappings of a batch of pairs of Alignments. All secondaries must have is_secondary set already. The tlen_limit_batch, if specified, is the maximum pairing distance for each pair to flag properly paired, if the output format cares about such things. TODO: Move to a properly paired annotation that runs with the Alignment.

Both ends of each pair must have the same number of mappings.

Implements vg::io::AlignmentEmitter.

◆ emit_mapped_singles()

virtual void vg::io::NullAlignmentEmitter::emit_mapped_singles ( vector< vector< Alignment >> &&  alns_batch)
inlinevirtual

Emit batch of Alignments with secondaries. All secondaries must have is_secondary set already.

Implements vg::io::AlignmentEmitter.

◆ emit_pairs()

virtual void vg::io::NullAlignmentEmitter::emit_pairs ( vector< Alignment > &&  aln1_batch,
vector< Alignment > &&  aln2_batch,
vector< int64_t > &&  tlen_limit_batch 
)
inlinevirtual

Emit a batch of pairs of Alignments. The tlen_limit_batch, if specified, is the maximum pairing distance for ewch pair to flag properly paired, if the output format cares about such things. TODO: Move to a properly paired annotation that runs with the Alignment.

Implements vg::io::AlignmentEmitter.

◆ emit_singles()

virtual void vg::io::NullAlignmentEmitter::emit_singles ( vector< Alignment > &&  aln_batch)
inlinevirtual

Emit a batch of Alignments.

Implements vg::io::AlignmentEmitter.


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