OpenMS  3.0.0
StreamHandler.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2022.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Timo Sachsenberg$
32 // $Authors: Stephan Aiche$
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
38 #include <map>
39 #include <iosfwd>
40 
41 namespace OpenMS
42 {
68  class OPENMS_DLLAPI StreamHandler
69  {
70 public:
75  {
77  STRING
78  };
79 
81  StreamHandler();
82 
84  virtual ~StreamHandler();
85 
98  Int registerStream(StreamType const type, const String & stream_name);
99 
110  void unregisterStream(StreamType const type, const String & stream_name);
111 
124  std::ostream & getStream(StreamType const type, const String & stream_name);
125 
135  bool hasStream(const StreamType type, const String & stream_name);
136 
137 protected:
138 
139  std::map<String, std::ostream *> name_to_stream_map_;
140  std::map<String, StreamType> name_to_type_map_;
141  std::map<String, Size> name_to_counter_map_;
142 
151  std::ostream * createStream_(const StreamType type, const String & stream_name);
152 
153 private:
154  // copy constructor and assignment operator are hidden to avoid
155  // creating multiple pointers to a single filestream instance
156 
158  StreamHandler(const StreamHandler & source);
159 
161  virtual StreamHandler & operator=(const StreamHandler & source);
162 
163  friend OPENMS_DLLAPI std::ostream & operator<<(std::ostream & os, StreamHandler const & stream_handler);
164  };
165 
167  OPENMS_DLLAPI std::ostream & operator<<(std::ostream & os, StreamHandler const & stream_handler);
168 
170  OPENMS_DLLAPI extern StreamHandler STREAM_HANDLER;
171 } // end namespace OpenMS
172 
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::StreamHandler::FILE
Definition: StreamHandler.h:76
OpenMS::StreamHandler::name_to_stream_map_
std::map< String, std::ostream * > name_to_stream_map_
Maps all registered stream names to the corresponding std::ostream.
Definition: StreamHandler.h:139
OpenMS::Int
int Int
Signed integer type.
Definition: Types.h:102
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::StreamHandler::StreamType
StreamType
Defines the type of the stream that should be handled.
Definition: StreamHandler.h:74
OpenMS::operator<<
std::ostream & operator<<(std::ostream &os, const AccurateMassSearchResult &amsr)
OpenMS::StreamHandler::name_to_type_map_
std::map< String, StreamType > name_to_type_map_
Maps all registered stream names to the corresponding StreamHandler::StreamType.
Definition: StreamHandler.h:140
OpenMS::StreamHandler
Provides a central class to register globally used output streams. Currently supported streams are.
Definition: StreamHandler.h:68
String.h
OpenMS::StreamHandler::name_to_counter_map_
std::map< String, Size > name_to_counter_map_
Maps all registered stream names to the number of times it was registered. If the counter goes to zer...
Definition: StreamHandler.h:141
OpenMS::STREAM_HANDLER
StreamHandler STREAM_HANDLER
Global StreamHandler instance.