QualityValues¶
#include <pbbam/QualityValues.h>
-
class
PacBio::BAM::
QualityValues
¶ The QualityValues class represents a sequence of FASTQ-compatible quality values. See QualityValue documentation for more details.
Inherits from std::vector< QualityValue >
Constructors & Related Methods
-
QualityValues
()¶ Default constructor - creates an empty QualityValues object.
-
QualityValues
(const std::string &fastqString)¶ Creates a QualityValues object from a FASTQ-encoded string.
- Parameters
fastqString
: FASTQ-encoded string
-
QualityValues
(const std::vector<QualityValue> &quals)¶ Creates a QualityValues object from a vector of QualityValue elements.
- Parameters
quals
: vector of QualityValue elements
-
QualityValues
(std::vector<QualityValue> &&quals)¶ Creates a QualityValues object from a vector of QualityValue elements.
- Parameters
quals
: vector of QualityValue elements
-
QualityValues
(const std::vector<uint8_t> &quals)¶ Creates a QualityValues object from a vector of (numeric) quality values.
- Parameters
quals
: vector of quality value numbers
-
QualityValues
(const std::vector<uint8_t>::const_iterator first, const std::vector<uint8_t>::const_iterator last)¶ Creates a QualityValues object from the contents of the range: [first, last)
- Parameters
first
: input iterator, whose element is a numeric qualitylast
: input iterator, whose element is a numeric quality
-
QualityValues
(const QualityValues::const_iterator first, const QualityValues::const_iterator last)¶ Creates a QualityValues object from the contents of the range: [first, last)
- Parameters
first
: input iterator, whose element is a QualityValuelast
: input iterator, whose element is a QualityValue
-
QualityValues
(const QualityValues &other)¶ Copy constructor.
-
QualityValues
(QualityValues &&other)¶ Move constructor.
-
QualityValues &
operator=
(const QualityValues &other)¶ Copy assignment operator.
- Parameters
other
: QualityValues object
-
QualityValues &
operator=
(QualityValues &&other)¶ Move assignment operator.
- Parameters
other
: QualityValues object
-
QualityValues &
operator=
(const std::vector<QualityValue> &quals)¶ Copy assignment operator.
- Parameters
quals
: vector of QualityValue elements
-
QualityValues &
operator=
(std::vector<QualityValue> &&quals)¶ Move assignment operator.
- Parameters
quals
: vector of QualityValue elements
-
~QualityValues
()¶ Destructor.
Comparison Operators
-
bool
operator==
(const std::string &other) const¶
-
bool
operator!=
(const std::string &other) const¶
Iterators
-
std::vector<QualityValue>::const_iterator
cbegin
() const¶ - Return
- a const_iterator to the beginning of the sequence
-
std::vector<QualityValue>::const_iterator
cend
() const¶ - Return
- a const_iterator to the element following the last element
-
std::vector<QualityValue>::const_iterator
begin
() const¶ - Return
- a const_iterator to the beginning of the sequence
-
std::vector<QualityValue>::const_iterator
end
() const¶ - Return
- a const_iterator to the element following the last element
-
std::vector<QualityValue>::iterator
begin
()¶ - Return
- an iterator to the beginning of the sequence
-
std::vector<QualityValue>::iterator
end
()¶ - Return
- an iterator to the element following the last element
Conversion Methods
-
std::string
Fastq
() const¶ - Return
- the FASTQ-encoded string for this sequence of quality values
Public Static Functions
-
static QualityValues
FromFastq
(const std::string &fastq)¶ Creates a QualityValues object from a FASTQ-encoded string.
- Return
- corresponding QualityValues object
- Parameters
fastq
: FASTQ-encoded string
-