ContigFile - SeqAn API Documentation

# Class ContigFile
Represents a file containing contigs.

Defined in | <seqan/store.h>
Signature | `template <[typename TSpec]> class ContigFile;`

## Template Parameters

`TSpec` | The specializing type. Default: `void`.

## Member Variable Overview

- `CharString ContigFile::fileName`
  Contig file name.
- `TId ContigFile::firstContigId`
  The contigId of the first sequence in the file. Subsequent contig sequences have an increasing contigId.
- `AutoSeqFormat ContigFile::format`
  Stores the contig file format, auto-detect in loadContigs.

## Detailed Description

Value type of contigFileStore string.

## Member Variables Detail

### `CharString ContigFile::fileName`

Contig file name.

### `TId ContigFile::firstContigId`

The contigId of the first sequence in the file. Subsequent contig sequences have an increasing contigId.

### `AutoSeqFormat ContigFile::format`

Stores the contig file format, auto-detect in loadContigs.

#### Dox Sources

    /*!
     * @class ContigFile
     *
     * @headerfile <seqan/store.h>
     *
     * @brief Represents a file containing contigs.
     *
     * @signature template <[typename TSpec]> class ContigFile;
     *
     * @tparam TSpec The specializing type. Default: <tt>void</tt>.
     *
     * Value type of @link FragmentStore::contigFileStore @endlink string.
     *
     * @var CharString ContigFile::fileName;
     *
     * @brief Contig file name.
     *
     * @var AutoSeqFormat ContigFile::format;
     *
     * @brief Stores the contig file format, auto-detect in @link
     *        FragmentStore#loadContigs @endlink.
     *
     * @var TId ContigFile::firstContigId;
     *
     * @brief The contigId of the first sequence in the file. Subsequent contig
     *        sequences have an increasing contigId.
     */