Public Member Functions | Friends | List of all members
index_info Class Reference

#include <index_metric.h>

Public Member Functions

 index_info ()
 
 index_info (const std::string &index_seq, const std::string &sample_id, const std::string &sample_proj, const ::uint64_t cluster_count)
 
const std::string & index_seq () const
 
const std::string & sample_id () const
 
const std::string & sample_proj () const
 
::uint64_t cluster_count () const
 
bool is_dual () const
 
std::string index1 () const
 
std::string index2 () const
 
std::string unique_id () const
 

Friends

template<class MetricType , int Version>
struct io::generic_layout
 

Detailed Description

Index information

This class defines all the information that describes an index within a sequencing run.

Note
Supported versions: 1, 2

Constructor & Destructor Documentation

index_info ( )
inline

Constructor

index_info ( const std::string &  index_seq,
const std::string &  sample_id,
const std::string &  sample_proj,
const ::uint64_t  cluster_count 
)
inline

Constructor

Parameters
index_seqindex sequence
sample_idsample id
sample_projsample project
cluster_countnumber of index sequences

Friends And Related Function Documentation

friend struct io::generic_layout
friend
The documentation for this class was generated from the following file: