A library for working with phylogenetic and population genetic data.
v0.32.0
stream/variant_input_stream.hpp
Go to the documentation of this file.
1 #ifndef GENESIS_POPULATION_STREAM_VARIANT_INPUT_STREAM_H_
2 #define GENESIS_POPULATION_STREAM_VARIANT_INPUT_STREAM_H_
3 
4 /*
5  Genesis - A toolkit for working with phylogenetic data.
6  Copyright (C) 2014-2024 Lucas Czech
7 
8  This program is free software: you can redistribute it and/or modify
9  it under the terms of the GNU General Public License as published by
10  the Free Software Foundation, either version 3 of the License, or
11  (at your option) any later version.
12 
13  This program is distributed in the hope that it will be useful,
14  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  GNU General Public License for more details.
17 
18  You should have received a copy of the GNU General Public License
19  along with this program. If not, see <http://www.gnu.org/licenses/>.
20 
21  Contact:
22  Lucas Czech <lczech@carnegiescience.edu>
23  Department of Plant Biology, Carnegie Institution For Science
24  260 Panama Street, Stanford, CA 94305, USA
25 */
26 
37 
38 #include <string>
39 #include <vector>
40 
41 namespace genesis {
42 namespace population {
43 
44 // =================================================================================================
45 // Generic Variant Stream
46 // =================================================================================================
47 
62 {
66  std::string file_path;
67 
73  std::string source_name;
74 
85  std::vector<std::string> sample_names;
86 };
87 
109 
110 } // namespace population
111 } // namespace genesis
112 
113 #endif // include guard
genesis::population::VariantInputStreamData::source_name
std::string source_name
User-readable name of the input source.
Definition: stream/variant_input_stream.hpp:73
sample_counts.hpp
generic_input_stream.hpp
genesis
Container namespace for all symbols of genesis in order to keep them separate when used as a library.
Definition: placement/formats/edge_color.cpp:42
genesis::population::VariantInputStreamData
Data storage for input-specific information when traversing a variant file.
Definition: stream/variant_input_stream.hpp:61
genesis::population::VariantInputStreamData::sample_names
std::vector< std::string > sample_names
Sample names, for example as found in the file header.
Definition: stream/variant_input_stream.hpp:85
variant.hpp
genesis::population::VariantInputStreamData::file_path
std::string file_path
Full file path, when reading from a file.
Definition: stream/variant_input_stream.hpp:66
genesis::utils::GenericInputStream
Type erasure for iterators, using std::function to eliminate the underlying input type.
Definition: generic_input_stream.hpp:163