A toolkit for working with phylogenetic data.
v0.24.0
string_output_target.hpp
Go to the documentation of this file.
1 #ifndef GENESIS_UTILS_IO_STRING_OUTPUT_TARGET_H_
2 #define GENESIS_UTILS_IO_STRING_OUTPUT_TARGET_H_
3 
4 /*
5  Genesis - A toolkit for working with phylogenetic data.
6  Copyright (C) 2014-2020 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 <lucas.czech@h-its.org>
23  Exelixis Lab, Heidelberg Institute for Theoretical Studies
24  Schloss-Wolfsbrunnenweg 35, D-69118 Heidelberg, Germany
25 */
26 
35 
36 #include <sstream>
37 #include <string>
38 
39 namespace genesis {
40 namespace utils {
41 
42 // =================================================================================================
43 // String Output Target
44 // =================================================================================================
45 
55 {
56 public:
57 
58  // -------------------------------------------------------------
59  // Constructors and Rule of Five
60  // -------------------------------------------------------------
61 
65  explicit StringOutputTarget( std::string& target )
66  : target_( target )
67  {}
68 
69  StringOutputTarget( StringOutputTarget const& ) = delete;
71 
74 
76  {
77  target_ = stream_.str();
78  }
79 
80  // -------------------------------------------------------------
81  // Overloaded Internal Members
82  // -------------------------------------------------------------
83 
84 private:
85 
89  std::ostream& out_stream_() override
90  {
91  return stream_;
92  }
93 
97  std::string target_name_() const override
98  {
99  return "output string";
100  }
101 
105  std::string target_string_() const override
106  {
107  return "string";
108  }
109 
110  // -------------------------------------------------------------
111  // Member Variables
112  // -------------------------------------------------------------
113 
114  std::string& target_;
115  std::ostringstream stream_;
116 };
117 
118 } // namespace utils
119 } // namespace genesis
120 
121 #endif // include guard
Abstract base class for writing data to an output target.
Container namespace for all symbols of genesis in order to keep them separate when used as a library...
StringOutputTarget & operator=(StringOutputTarget const &)=delete
StringOutputTarget(std::string &target)
Construct the output target to a string that is modified.
Output target for writing data to a string.