RnaHeader - SeqAn API Documentation

# Class RnaHeader
A container for labels of several RNA structures.

Defined in | <seqan/rna_io.h>
Signature | `class RnaHeader;`

## Member Function Overview

- `RnaHeader::RnaHeader()`
  The constructor.

## Member Variable Overview

- `StringSet<CharString> RnaHeader::bppLabels`
  List of base pair probability matrix computation methods.
- `CharString RnaHeader::description`
  Free text for file description.
- `StringSet<CharString> RnaHeader::fixLabels`
  List of fixed structure computation methods.
- `StringSet<CharString> RnaHeader::seqLabels`
  List of sequence names.
- `StringSet<CharString> RnaHeader::typeLabels`
  List of types of biological validated data.

## Detailed Description

The container stores all kinds of data that can be obtained by reading RNA structure file headers.

## Member Functions Detail

### `RnaHeader::RnaHeader()`

The constructor.

#### Data Races

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

## Member Variables Detail

### `StringSet<CharString> RnaHeader::bppLabels`

List of base pair probability matrix computation methods.

### `CharString RnaHeader::description`

Free text for file description.

### `StringSet<CharString> RnaHeader::fixLabels`

List of fixed structure computation methods.

### `StringSet<CharString> RnaHeader::seqLabels`

List of sequence names.

### `StringSet<CharString> RnaHeader::typeLabels`

List of types of biological validated data.

#### Dox Sources

    /*!
     * @class RnaHeader
     *
     * @headerfile <seqan/rna_io.h>
     *
     * @brief A container for labels of several RNA structures.
     *
     * @signature class RnaHeader;
     *
     * The container stores all kinds of data that can be obtained by reading RNA
     * structure file headers.
     *
     * @fn RnaHeader::RnaHeader
     *
     * @brief The constructor.
     *
     * @signature RnaHeader::RnaHeader()
     *
     * @var CharString RnaHeader::description;
     *
     * @brief Free text for file description.
     *
     * @var StringSet<CharString> RnaHeader::seqLabels;
     *
     * @brief List of sequence names.
     *
     * @var StringSet<CharString> RnaHeader::fixLabels;
     *
     * @brief List of fixed structure computation methods.
     *
     * @var StringSet<CharString> RnaHeader::bppLabels;
     *
     * @brief List of base pair probability matrix computation methods.
     *
     * @var StringSet<CharString> RnaHeader::typeLabels;
     *
     * @brief List of types of biological validated data.
     */