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

Represents the content of dBAR file.

Constructors, destructors, conversion operators

DBAR()
Default constructor.
DBAR(std::initializer_list<std::pair<std::tuple<int, uint32_t, uint32_t, uint32_t>, std::initializer_list<std::tuple<uint32_t, int, uint32_t>>>> blocks) explicit
Constructor.
~DBAR() noexcept
Default destructor.

Public functions

auto arcs_value(const size_type block_idx, const size_type track_idx) const -> const uint32_t&
ARCS value of a track.
auto block(const size_type block_idx) const -> DBARBlock
Checksum block in DBAR object.
auto confidence_value(const size_type block_idx, const size_type track_idx) const -> const unsigned&
Confidence value of a track.
auto empty() const -> bool noexcept
Returns TRUE iff DBAR is empty, otherwise FALSE.
auto frame450_arcs_value(const size_type block_idx, const size_type track_idx) const -> const uint32_t&
ARCS value of frame 450 of a track.
auto header(const size_type block_idx) const -> DBARBlockHeader
Header of the specified block.
auto size() const -> size_type noexcept
Total number of blocks.
auto size(const size_type block_idx) const -> size_type
Physical total number of tracks in the specified block.
auto total_tracks(const size_type block_idx) const -> unsigned
Total number of tracks the specified block declares.
auto triplet(const size_type block_idx, const size_type track_idx) const -> DBARTriplet
Triplet representing the specified track.

Function documentation

arcstk::v_1_0_0::DBAR::DBAR(std::initializer_list<std::pair<std::tuple<int, uint32_t, uint32_t, uint32_t>, std::initializer_list<std::tuple<uint32_t, int, uint32_t>>>> blocks) explicit

Constructor.

Parameters
blocks in List of DBAR block literals.

Intended for writing tests.

const uint32_t& arcstk::v_1_0_0::DBAR::arcs_value(const size_type block_idx, const size_type track_idx) const

ARCS value of a track.

Parameters
block_idx in Specified block index
track_idx in Specified track index
Returns ARCS value of the specified track

DBARBlock arcstk::v_1_0_0::DBAR::block(const size_type block_idx) const

Checksum block in DBAR object.

Parameters
block_idx in Index of the block in the DBAR object
Returns Block with index block_idx

The returned object will hold references to the values.

const unsigned& arcstk::v_1_0_0::DBAR::confidence_value(const size_type block_idx, const size_type track_idx) const

Confidence value of a track.

Parameters
block_idx in Specified block index
track_idx in Specified track index
Returns Confidence value of the specified track

bool arcstk::v_1_0_0::DBAR::empty() const noexcept

Returns TRUE iff DBAR is empty, otherwise FALSE.

Returns TRUE iff DBAR is empty, otherwise FALSE.

const uint32_t& arcstk::v_1_0_0::DBAR::frame450_arcs_value(const size_type block_idx, const size_type track_idx) const

ARCS value of frame 450 of a track.

Parameters
block_idx in Specified block index
track_idx in Specified track index
Returns ARCS value frame 450 of the specified track

DBARBlockHeader arcstk::v_1_0_0::DBAR::header(const size_type block_idx) const

Header of the specified block.

Parameters
block_idx in Block to return header of
Returns Header of the specified block.

The returned object will hold copies of the values.

size_type arcstk::v_1_0_0::DBAR::size() const noexcept

Total number of blocks.

Returns Total number of blocks

size_type arcstk::v_1_0_0::DBAR::size(const size_type block_idx) const

Physical total number of tracks in the specified block.

Returns Size of the specified block

unsigned arcstk::v_1_0_0::DBAR::total_tracks(const size_type block_idx) const

Total number of tracks the specified block declares.

Parameters
block_idx in Block to access
Returns Total number of tracks as declared

DBARTriplet arcstk::v_1_0_0::DBAR::triplet(const size_type block_idx, const size_type track_idx) const

Triplet representing the specified track.

Parameters
block_idx in Block to lookup track
track_idx in Track to return
Returns Specified triplet

The returned object will hold copies of the values.