Sample SNPs
Fast ordered sampling of rows from large text or binary files. Special cases for DNA variant files (.bed, VCF, HapMap, etc).
Public Member Functions | Protected Attributes | List of all members
sampFiles::GtxtFile Class Reference

Generic text file base class. More...

#include <varfiles.hpp>

Inheritance diagram for sampFiles::GtxtFile:
[legend]
Collaboration diagram for sampFiles::GtxtFile:
[legend]

Public Member Functions

 GtxtFile ()
 Default constructor.
 
 GtxtFile (const string &fileName)
 Constructor with file name. More...
 
 GtxtFile (const string &fileName, const bool &head)
 Constructor with file name and header indicator. More...
 
 GtxtFile (const GtxtFile &in)=default
 Copy constructor.
 
GtxtFileoperator= (const GtxtFile &in)=default
 Copy assignment.
 
 GtxtFile (GtxtFile &&in)=default
 Move constructor.
 
GtxtFileoperator= (GtxtFile &&in)=default
 Move assignment.
 
 ~GtxtFile ()
 Destructor.
 
virtual void open ()
 Open stream (does nothing)
 
virtual void close ()
 Close stream.
 
- Public Member Functions inherited from sampFiles::VarFile
 VarFile (const VarFile &in)=default
 Copy constructor.
 
VarFileoperator= (const VarFile &in)=default
 Copy assignment.
 
 VarFile (VarFile &&in)=default
 Move constructor.
 
VarFileoperator= (VarFile &&in)=default
 Move assignment.
 
 ~VarFile ()
 Destructor.
 

Protected Attributes

string _fileName
 File name.
 
bool _head
 Is there a header?
 
- Protected Attributes inherited from sampFiles::VarFile
fstream _varFile
 Variant file stream.
 

Additional Inherited Members

- Protected Member Functions inherited from sampFiles::VarFile
 VarFile ()
 Default constructor (protected)
 

Detailed Description

Generic text file base class.

Sets up streams for text files. If specified, the first line can be considered a header and treated separately.

Constructor & Destructor Documentation

◆ GtxtFile() [1/2]

sampFiles::GtxtFile::GtxtFile ( const string &  fileName)
inline

Constructor with file name.

Parameters
[in]fileNamefile name

◆ GtxtFile() [2/2]

sampFiles::GtxtFile::GtxtFile ( const string &  fileName,
const bool &  head 
)
inline

Constructor with file name and header indicator.

Parameters
[in]fileNamefile name
[in]headheader presence

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