Class
VcfIOContextThe I/O context to use for VCF I/O.
The I/O context to use for VCF I/O.
Defined in | <seqan/vcf_io.h> |
---|---|
Signature |
template <typename TNameStore[, typename TNameStoreCache]>
class VcfIOContext;
|
Template Parameters
TNameStore |
The type used to represent the names. |
---|---|
TNameStoreCache |
The type used to cache the names. Defaults to NameStoreCache <TNameStore>l;. |
Member Function Overview
Interface Function Overview
-
TNameStoreRef contigNames(context);
Return reference to the contig names from VcfIOContext. -
TNameStoreCacheRef contigNamesCache(context);
Return reference to contig names cache from VcfIOContext. -
TNameStoreRef sampleNames(context);
Return reference to the sample names from VcfIOContext.
Member Functions Detail
VcfIOContext::VcfIOContext();
VcfIOContext::VcfIOContext(contigNames, sampleNames);
Constructor.
Default constructor or construction with references to contig and sample names.
Data Races
Thread safety unknown!
Interface Functions Detail
TNameStoreRef contigNames(context);
Return reference to the contig names from VcfIOContext.
Parameters
context
|
The VcfIOContext to query. |
---|
Returns
TNameStoreRef |
A reference to the TNameStore of the context. |
---|
Data Races
Thread safety unknown!
TNameStoreCacheRef contigNamesCache(context);
Return reference to contig names cache from VcfIOContext.
Parameters
context
|
The BamIOContext to query. |
---|
Returns
TNameStoreCacheRef |
A reference to the TNameStoreCache of the context. |
---|
Data Races
Thread safety unknown!
TNameStoreRef sampleNames(context);
Return reference to the sample names from VcfIOContext.
Parameters
context
|
The VcfIOContext to query. |
---|
Returns
TNameStoreRef |
A reference to the TNameStore of the context. |
---|
Data Races
Thread safety unknown!