LoggerImpl.h
Go to the documentation of this file.
1 // kate: replace-tabs off; indent-width 4; indent-mode normal
2 // vim: ts=4:sw=4:noexpandtab
3 /*
4 
5 Copyright (c) 2010--2012,
6 Fran├žois Pomerleau and Stephane Magnenat, ASL, ETHZ, Switzerland
7 You can contact the authors at <f dot pomerleau at gmail dot com> and
8 <stephane at magnenat dot net>
9 
10 All rights reserved.
11 
12 Redistribution and use in source and binary forms, with or without
13 modification, are permitted provided that the following conditions are met:
14  * Redistributions of source code must retain the above copyright
15  notice, this list of conditions and the following disclaimer.
16  * Redistributions in binary form must reproduce the above copyright
17  notice, this list of conditions and the following disclaimer in the
18  documentation and/or other materials provided with the distribution.
19  * Neither the name of the <organization> nor the
20  names of its contributors may be used to endorse or promote products
21  derived from this software without specific prior written permission.
22 
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
24 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
25 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
26 DISCLAIMED. IN NO EVENT SHALL ETH-ASL BE LIABLE FOR ANY
27 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
28 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
30 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 
34 */
35 
36 #ifndef __POINTMATCHER_LOGGER_H
37 #define __POINTMATCHER_LOGGER_H
38 
39 #include "PointMatcher.h"
40 #include <fstream>
41 
42 namespace PointMatcherSupport
43 {
44  struct NullLogger: public Logger
45  {
46  inline static const std::string description()
47  {
48  return "Does not log anything.";
49  }
50  NullLogger(): Logger("NullLogger",
51  ParametersDoc(),
52  Parameters()) {}
53  };
54 
55  struct FileLogger: public Logger
56  {
57  inline static const std::string description()
58  {
59  return "Log using std::stream.";
60  }
61  inline static const ParametersDoc availableParameters()
62  {
63  return {
64  {"infoFileName", "name of the file to output infos to, or an empty string to output infos to the standard output stream", ""},
65  {"warningFileName", "name of the file to output warnings to, or an empty string to output warnings to the standard error stream", ""},
66  {"displayLocation", "display the location of message in source code", "0"}
67  };
68  };
69 
72  const bool displayLocation;
73 
75 
76  virtual bool hasInfoChannel() const;
77  virtual void beginInfoEntry(const char *file, unsigned line, const char *func);
78  virtual std::ostream* infoStream();
79  virtual void finishInfoEntry(const char *file, unsigned line, const char *func);
80  virtual bool hasWarningChannel() const;
81  virtual void beginWarningEntry(const char *file, unsigned line, const char *func);
82  virtual std::ostream* warningStream();
83  virtual void finishWarningEntry(const char *file, unsigned line, const char *func);
84 
85  protected:
86  std::ofstream _infoFileStream;
87  std::ofstream _warningFileStream;
88  std::ostream _infoStream;
89  std::ostream _warningStream;
90  };
91 } //PointMatcherSupport
92 
93 #endif // __POINTMATCHER_LOGGER_H
PointMatcherSupport::FileLogger::beginWarningEntry
virtual void beginWarningEntry(const char *file, unsigned line, const char *func)
Start a new entry into the warning channel.
Definition: LoggerImpl.cpp:109
PointMatcherSupport::NullLogger::NullLogger
NullLogger()
Definition: LoggerImpl.h:50
PointMatcherSupport::NullLogger::description
static const std::string description()
Definition: LoggerImpl.h:46
PointMatcherSupport::FileLogger
Definition: LoggerImpl.h:55
PointMatcherSupport::FileLogger::beginInfoEntry
virtual void beginInfoEntry(const char *file, unsigned line, const char *func)
Start a new entry into the info channel.
Definition: LoggerImpl.cpp:87
PointMatcherSupport::FileLogger::warningFileName
const std::string warningFileName
Definition: LoggerImpl.h:71
PointMatcherSupport::FileLogger::_infoFileStream
std::ofstream _infoFileStream
Definition: LoggerImpl.h:86
PointMatcherSupport::FileLogger::description
static const std::string description()
Definition: LoggerImpl.h:57
PointMatcherSupport::FileLogger::displayLocation
const bool displayLocation
Definition: LoggerImpl.h:72
PointMatcherSupport::Logger
The logger interface, used to output warnings and informations.
Definition: PointMatcher.h:104
PointMatcherSupport::FileLogger::warningStream
virtual std::ostream * warningStream()
Return the warning stream, 0 if hasWarningChannel() returns false.
Definition: LoggerImpl.cpp:113
PointMatcherSupport::FileLogger::finishInfoEntry
virtual void finishInfoEntry(const char *file, unsigned line, const char *func)
Finish the entry into the info channel.
Definition: LoggerImpl.cpp:96
PointMatcherSupport::FileLogger::FileLogger
FileLogger(const Parameters &params=Parameters())
Definition: LoggerImpl.cpp:45
testing::internal::string
::std::string string
Definition: gtest.h:1979
setup.file
file
Definition: setup.py:28
PointMatcherSupport::FileLogger::infoStream
virtual std::ostream * infoStream()
Return the info stream, 0 if hasInfoChannel() returns false.
Definition: LoggerImpl.cpp:91
PointMatcherSupport::FileLogger::infoFileName
const std::string infoFileName
Definition: LoggerImpl.h:68
PointMatcherSupport::Parametrizable::ParametersDoc
std::vector< ParameterDoc > ParametersDoc
The documentation of all parameters.
Definition: Parametrizable.h:187
align_sequence.params
params
Definition: align_sequence.py:13
PointMatcherSupport::FileLogger::availableParameters
static const ParametersDoc availableParameters()
Definition: LoggerImpl.h:61
PointMatcherSupport::FileLogger::finishWarningEntry
virtual void finishWarningEntry(const char *file, unsigned line, const char *func)
Finish the entry into the warning channel.
Definition: LoggerImpl.cpp:118
PointMatcherSupport::FileLogger::_infoStream
std::ostream _infoStream
Definition: LoggerImpl.h:88
PointMatcherSupport::NullLogger
Definition: LoggerImpl.h:44
PointMatcherSupport::FileLogger::hasWarningChannel
virtual bool hasWarningChannel() const
Return whether this logger provides the warning channel.
Definition: LoggerImpl.cpp:104
PointMatcherSupport::FileLogger::_warningStream
std::ostream _warningStream
Definition: LoggerImpl.h:89
PointMatcherSupport::FileLogger::_warningFileStream
std::ofstream _warningFileStream
Definition: LoggerImpl.h:87
PointMatcherSupport
Functions and classes that are not dependant on scalar type are defined in this namespace.
Definition: Bibliography.cpp:45
PointMatcher.h
public interface
PointMatcherSupport::FileLogger::hasInfoChannel
virtual bool hasInfoChannel() const
Return whether this logger provides the info channel.
Definition: LoggerImpl.cpp:82
PointMatcherSupport::Parametrizable::Parameters
std::map< std::string, Parameter > Parameters
Parameters stored as a map of string->string.
Definition: Parametrizable.h:199


libpointmatcher
Author(s):
autogenerated on Mon Jan 1 2024 03:24:43