multovl  1.3
Multiple overlaps of genomic regions
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
Public Types | Static Public Member Functions | List of all members
multovl::io::Fileformat Class Reference

#include "fileformat.hh"

Public Types

enum  Kind {
  UNKNOWN = 0, BED = 1, GFF2 = 2, GFF3 = 4,
  GFF = 6, BAM = 8
}
 

Static Public Member Functions

static Kind from_filename (const std::string &filenm)
 
static std::string to_string (Kind format)
 
static std::string known_extensions ()
 

Detailed Description

The Fileformat class encapsulates file format handling. It provides the Kind enum for the format types it knows about, and some static methods to deduce these types.

Member Function Documentation

static Kind multovl::io::Fileformat::from_filename ( const std::string &  filenm)
static

Deduces the format from the filename extension.

Parameters
filenmthe filename. The extension should be ".bed", ".gff", ".bam", ... etc.
Returns
one of the non-0 Fileformat::Kind constants or Fileformat::Kind::UNKNOWN if the extension did not match anything this method knows about.
static std::string multovl::io::Fileformat::known_extensions ( )
static
Returns
a string listing the known filename extensions, e.g. ".bed, .gff, .gtf"
static std::string multovl::io::Fileformat::to_string ( Kind  format)
static

Converts the format const to a string

Parameters
formatone of the valid formats
Returns
the string representation of /format/

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