Gamgee
You miserable little maggot. I'll stove your head in!
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
gamgee::VariantFilters Class Reference

class to manipulate filter field objects without making copies. More...

#include <variant_filters.h>

Public Member Functions

 VariantFilters (const std::shared_ptr< bcf_hdr_t > &header, const std::shared_ptr< bcf1_t > &body)
 standard constructor used by the Variant API More...
 
std::string operator[] (int index) const
 random access operator More...
 
uint32_t size () const
 returns the number of filters in the filter field More...
 
bool missing () const
 returns true if the filters field is missing More...
 
VariantFiltersIterator begin () const
 returns an iterator pointing to the first element in the list of filters. More...
 
VariantFiltersIterator end () const
 Returns an iterator referring to one-past-the-last element in the list of filters. More...
 

Detailed Description

class to manipulate filter field objects without making copies.

It provides all the functionality that a vector of strings should provide. You can do random access or iteration style access on it. The iterator is implemented as a random iterator for maximum flexibility with standard library functions

Constructor & Destructor Documentation

gamgee::VariantFilters::VariantFilters ( const std::shared_ptr< bcf_hdr_t > &  header,
const std::shared_ptr< bcf1_t > &  body 
)
inlineexplicit

standard constructor used by the Variant API

Parameters
headeran htslib variant header to keep shared ownership of the memory
bodyan htslib variant body to keep shared ownership of the memory

Member Function Documentation

VariantFiltersIterator gamgee::VariantFilters::begin ( ) const
inline

returns an iterator pointing to the first element in the list of filters.

VariantFiltersIterator gamgee::VariantFilters::end ( ) const
inline

Returns an iterator referring to one-past-the-last element in the list of filters.

bool gamgee::VariantFilters::missing ( ) const
inline

returns true if the filters field is missing

std::string gamgee::VariantFilters::operator[] ( int  index) const
inline

random access operator

Parameters
indexthe filter index
uint32_t gamgee::VariantFilters::size ( ) const
inline

returns the number of filters in the filter field


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