arcstk::v_1_0_0::DBARBlock class final
#include <dbar.hpp>

A block in a DBAR.

A block consists of a header containing the ARId in a binary representation and a sequence of triplets with each consisting of the actual ARCS, a confidence value and the ARCS of frame 450 of the track.

Public types

using const_iterator = const iterator
Constant iterator type.
using iterator = DBARForwardIterator<DBARBlock>
Iterator type.
using size_type = std::size_t
Size type for this type, also used for indexing.
using value_type = DBARTriplet
Value type for this type.

Constructors, destructors, conversion operators

DBARBlock()
Default constructor.
DBARBlock(const DBAR& dBAR, const DBAR::size_type block_idx)
Constructor.

Public functions

auto header() const -> DBARBlockHeader
Header of this DBAR block.
auto id() const -> ARId
ARId of this block.
auto index() const -> size_type noexcept
Index of this block.
void set(const DBAR& dBAR, const DBAR::size_type block_idx)
Set DBAR and block index.
auto size() const -> size_type
Size of this block.
auto triplet(const size_type t) const -> DBARTriplet
Access track of this block.

Function documentation

arcstk::v_1_0_0::DBARBlock::DBARBlock(const DBAR& dBAR, const DBAR::size_type block_idx)

Constructor.

Parameters
dBAR in Underlying DBAR object
block_idx in Index of the block to represent

DBARBlockHeader arcstk::v_1_0_0::DBARBlock::header() const

Header of this DBAR block.

Returns Header fo this DBAR block.

ARId arcstk::v_1_0_0::DBARBlock::id() const

ARId of this block.

Returns ARId of this block

size_type arcstk::v_1_0_0::DBARBlock::index() const noexcept

Index of this block.

Returns Index of this block.

void arcstk::v_1_0_0::DBARBlock::set(const DBAR& dBAR, const DBAR::size_type block_idx)

Set DBAR and block index.

Parameters
dBAR in Underlying DBAR object
block_idx in Index of the block to represent

size_type arcstk::v_1_0_0::DBARBlock::size() const

Size of this block.

Returns Size of this block.

The size of a block is the total number of tracks it contains. In a valid block, it is equal to header().total_tracks().

DBARTriplet arcstk::v_1_0_0::DBARBlock::triplet(const size_type t) const

Access track of this block.

Parameters
t in Index of the track to access.
Returns Track t of this block