BlastRecord - SeqAn API Documentation

# Class BlastRecord
A record of blast-matches (belonging to one query).

Implements | FormattedFileRecordConcept
All Impl'd | AssignableConcept, CopyConstructibleConcept, DefaultConstructibleConcept, FormattedFileRecordConcept
Defined in | <seqan/blast.h>
Signature | `struct BlastRecord<TMatch, ...> { ... };`

## Template Parameters

`TMatch` | Specialization of BlastMatch
`TQID` | Type of qId, defaults to TMatch::TQId
`TQAccs` | Type of qAccs, defaults to `std::vector` of `std::string`
`TLcaId` | Type of lcaId, defaults to `std::string`
`TLcaTaxId` | Type of lcaTaxId, defaults to `uint32_t`

## Member Function Overview

- `BlastRecord::BlastRecord() BlastRecord::BlastRecord(qid)`
  constructor, can be passed the qId

### Member Functions Inherited From AssignableConcept

- `operator=`

## Interface Function Overview

### Interface Functions Inherited From AssignableConcept

- `assign`
- `set`
- `move`

## Member Typedef Overview

- `typedef TBlastMatch_ TBlastMatch;`
  type of the contained matches

## Member Variable Overview

- `TPos BlastRecord::lcaId`
  String identifier (e.g. scientific name) of the lowest common ancestor of all matches.
- `TPos BlastRecord::lcaTaxId`
  Numeric taxonomic identifier of the lowest common ancestor of all matches.
- `std::list<TBlastMatch> BlastRecord::matches`
  list of the contained matches
- `TQId BlastRecord::qAccs`
  The Accession number(s) of the query.
- `TQId BlastRecord::qId`
  verbose Id of the query
- `TPos BlastRecord::qLength`
  length of the query sequence

## Member Functions Detail

### `BlastRecord::BlastRecord() BlastRecord::BlastRecord(qid)`

constructor, can be passed the qId

#### Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

## Member Typedef Detail

### `typedef TBlastMatch_ TBlastMatch;`

type of the contained matches

## Member Variables Detail

### `TPos BlastRecord::lcaId`

String identifier (e.g. scientific name) of the lowest common ancestor of all matches.

### `TPos BlastRecord::lcaTaxId`

Numeric taxonomic identifier of the lowest common ancestor of all matches.

### `std::list<TBlastMatch> BlastRecord::matches`

list of the contained matches

### `TQId BlastRecord::qAccs`

The Accession number(s) of the query.

### `TQId BlastRecord::qId`

verbose Id of the query

### `TPos BlastRecord::qLength`

length of the query sequence

#### Dox Sources

    /*!
     * @class BlastRecord
     *
     * @implements FormattedFileRecordConcept
     *
     * @headerfile <seqan/blast.h>
     *
     * @brief A record of blast-matches (belonging to one query).
     *
     * @signature struct BlastRecord<TMatch, ...> { ... };
     *
     * @tparam TMatch Specialization of @link BlastMatch @endlink
     * @tparam TQID Type of @link BlastRecord::qId @endlink, defaults to
     *              TMatch::TQId
     * @tparam TQAccs Type of @link BlastRecord::qAccs @endlink, defaults to
     *                <tt>std::vector</tt> of <tt>std::string</tt>
     * @tparam TLcaId Type of @link BlastRecord::lcaId @endlink, defaults to
     *                <tt>std::string</tt>
     * @tparam TLcaTaxId Type of @link BlastRecord::lcaTaxId @endlink, defaults to
     *                   <tt>uint32_t</tt>
     *
     * @fn BlastRecord::BlastRecord()
     *
     * @brief constructor, can be passed the qId
     *
     * @signature BlastRecord::BlastRecord() BlastRecord::BlastRecord(qid)
     *
     * @typedef BlastRecord::TBlastMatch
     *
     * @brief type of the contained matches
     *
     * @signature typedef TBlastMatch_ TBlastMatch;
     *
     * @var TQId BlastRecord::qId;
     *
     * @brief verbose Id of the query
     *
     * @var TPos BlastRecord::qLength;
     *
     * @brief length of the query sequence
     *
     * @var TQId BlastRecord::qAccs;
     *
     * @brief The Accession number(s) of the query.
     *
     * @var std::list<TBlastMatch> BlastRecord::matches;
     *
     * @brief list of the contained matches
     *
     * @var TPos BlastRecord::lcaId;
     *
     * @brief String identifier (e.g. scientific name) of the lowest common ancestor
     *        of all matches.
     *
     * @var TPos BlastRecord::lcaTaxId;
     *
     * @brief Numeric taxonomic identifier of the lowest common ancestor of all
     *        matches.
     */