yat  0.21pre
Public Member Functions | Friends | Related Functions | List of all members
theplu::yat::omic::VCF::Info Class Reference

class handling the INFO field in an VCF entry More...

#include <yat/omic/VCF.h>

Public Member Functions

 Info (void)=default
 default constructor
 
void add (const std::string &key)
 
template<typename T >
void add (const std::string &key, const T &value)
 
void clear (void)
 
size_t count (const std::string &key) const
 
template<typename T >
void get (T &result, const std::string &key) const
 
void remove (const std::string &key)
 remove Info entry with key key
 
void set (const std::string &s)
 
void set (std::string &&s)
 
const std::string & str (void) const
 
template<typename T >
void set (const std::string &key, const T &value)
 

Friends

class VCF
 
std::ostream & operator<< (std::ostream &, const VCF::Info &)
 

Related Functions

(Note that these are not member functions.)

std::ostream & operator<< (std::ostream &os, const VCF::Info &info)
 output operator for VCF::Info More...
 

Detailed Description

class handling the INFO field in an VCF entry

Member Function Documentation

◆ add() [1/2]

void theplu::yat::omic::VCF::Info::add ( const std::string &  key)

Add entry key to semicolon-delimited list of entries.

◆ add() [2/2]

template<typename T >
void theplu::yat::omic::VCF::Info::add ( const std::string &  key,
const T &  value 
)

T is either string or numeric or a std::vector with strings or numerics.

◆ clear()

void theplu::yat::omic::VCF::Info::clear ( void  )

Clear Info field.

◆ count()

size_t theplu::yat::omic::VCF::Info::count ( const std::string &  key) const
Returns
1 if key exists

◆ get()

template<typename T >
void theplu::yat::omic::VCF::Info::get ( T &  result,
const std::string &  key 
) const

get value corresponding to key

T is string, numeric, vector<string> or vector<numeric>

◆ set() [1/3]

void theplu::yat::omic::VCF::Info::set ( const std::string &  s)

Set info to s

◆ set() [2/3]

void theplu::yat::omic::VCF::Info::set ( std::string &&  s)

Set info to s

◆ set() [3/3]

template<typename T >
void theplu::yat::omic::VCF::Info::set ( const std::string &  key,
const T &  value 
)

T is either string or numeric or a std::vector with strings or numerics.

Since
New in yat 0.20

◆ str()

const std::string& theplu::yat::omic::VCF::Info::str ( void  ) const
Returns
info as a string

Friends And Related Function Documentation

◆ operator<<()

std::ostream & operator<< ( std::ostream &  os,
const VCF::Info info 
)
related

output operator for VCF::Info

Returns
stream

The documentation for this class was generated from the following file:

Generated on Wed Jan 25 2023 03:34:29 for yat by  doxygen 1.8.14