1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef itkFileOutputWindow_h
#define itkFileOutputWindow_h
#include "itkOutputWindow.h"
#include "itkObjectFactory.h"
#include <fstream>
namespace itk
{
/** \class FileOutputWindow
* \brief Messages sent from the system are sent to a file.
*
* Text messages that the system should display to the user are sent to
* this object (or subclasses of this object) and are logged to a file.
*
* \ingroup OSSystemObjects
*
* \ingroup ITKCommon
*
* \sphinx
* \sphinxexample{Core/Common/DirectWarningToFile,Direct Warning To File}
* \endsphinx
*/
class ITKCommon_EXPORT FileOutputWindow : public OutputWindow
{
public:
ITK_DISALLOW_COPY_AND_MOVE(FileOutputWindow);
/** Standard class type aliases. */
using Self = FileOutputWindow;
using Superclass = OutputWindow;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(FileOutputWindow);
/** Send a string to display. */
void
DisplayText(const char *) override;
/** Set the filename for the log file */
itkSetStringMacro(FileName);
/** Get the filename for the log file */
itkGetStringMacro(FileName);
/** Set/Get the buffer flushing mode */
itkSetMacro(Flush, bool);
itkGetConstMacro(Flush, bool);
itkBooleanMacro(Flush);
/** Setting append will cause the log file to be
* opened in append mode. Otherwise, if the log file exists,
* it will be overwritten each time the FileOutputWindow
* is created. */
itkSetMacro(Append, bool);
itkGetConstMacro(Append, bool);
itkBooleanMacro(Append);
protected:
FileOutputWindow();
~FileOutputWindow() override;
void
PrintSelf(std::ostream & os, Indent indent) const override;
void
Initialize();
std::ofstream * m_Stream{};
std::string m_FileName{};
bool m_Flush{};
bool m_Append{};
};
} // end namespace itk
#endif
|
