Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
LogConfigHandler.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-2017.
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 #ifndef OPENMS_CONCEPT_LOGCONFIGHANDLER_H
36 #define OPENMS_CONCEPT_LOGCONFIGHANDLER_H
37 
40 
43 
44 namespace OpenMS
45 {
46 
53  class OPENMS_DLLAPI LogConfigHandler
54  {
55 public:
56 
57  static String PARAM_NAME;
58 
83  Param parse(const StringList & setting);
84 
109  void configure(const Param & param);
110 
111 
119  ostream & getStream(const String & stream_name);
120 
124  static LogConfigHandler & getInstance();
125 
127  virtual ~LogConfigHandler();
128 protected:
129 
139  Logger::LogStream & getLogStreamByName_(const String & stream_name);
140 
148  std::set<String> & getConfigSetByName_(const String & stream_type);
149 
159  StreamHandler::StreamType getStreamTypeByName_(const String & stream_type);
160 
161  std::set<String> debug_streams_;
162  std::set<String> info_streams_;
163  std::set<String> warn_streams_;
164  std::set<String> error_streams_;
165  std::set<String> fatal_streams_;
166 
167  std::map<String, StreamHandler::StreamType> stream_type_map_;
168 
169 private:
170  friend OPENMS_DLLAPI std::ostream & operator<<(std::ostream & os, LogConfigHandler const & lch);
171 
172  // the pointer to the single instance
174 
175  // it is a singleton so we hide all c' and d'tors
176 
179 
181  LogConfigHandler(const LogConfigHandler & source);
182 
184  virtual LogConfigHandler & operator=(const LogConfigHandler & source);
185  };
186 
188  OPENMS_DLLAPI std::ostream & operator<<(std::ostream & os, LogConfigHandler const & lch);
189 
190 } // end namespace OpenMS
191 
192 #endif // #ifndef OPENMS_CONCEPT_LOGCONFIGHANDLER_H
A more convenient string class.
Definition: String.h:57
std::set< String > fatal_streams_
List of all streams that were appended to OpenMS::Log_fatal.
Definition: LogConfigHandler.h:165
std::set< String > error_streams_
List of all streams that were appended to OpenMS::Log_error.
Definition: LogConfigHandler.h:164
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
Log Stream Class.
Definition: LogStream.h:303
StreamType
Defines the type of the stream that should be handled.
Definition: StreamHandler.h:78
static LogConfigHandler * instance_
Definition: LogConfigHandler.h:173
std::ostream & operator<<(std::ostream &os, const AccurateMassSearchResult &amsr)
std::vector< String > StringList
Vector of String.
Definition: ListUtils.h:74
Management and storage of parameters / INI files.
Definition: Param.h:75
The LogConfigHandler provides the functionality to configure the internal logging of OpenMS algorithm...
Definition: LogConfigHandler.h:53
std::map< String, StreamHandler::StreamType > stream_type_map_
Maps the registered streams to a StreamHandler::StreamType.
Definition: LogConfigHandler.h:167
std::set< String > info_streams_
List of all streams that were appended to OpenMS::Log_info.
Definition: LogConfigHandler.h:162
std::set< String > debug_streams_
List of all streams that were appended to OpenMS::Log_debug.
Definition: LogConfigHandler.h:161
static String PARAM_NAME
Name of the parameter in which the configuration should be stored.
Definition: LogConfigHandler.h:57
std::set< String > warn_streams_
List of all streams that were appended to OpenMS::Log_warn.
Definition: LogConfigHandler.h:163

OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:22:01 using doxygen 1.8.13