ITK  5.3.0
Insight Toolkit
itkOutputWindow.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright NumFOCUS
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 /*=========================================================================
19  *
20  * Portions of this file are subject to the VTK Toolkit Version 3 copyright.
21  *
22  * Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
23  *
24  * For complete copyright, license and disclaimer of warranty information
25  * please refer to the NOTICE file at the top of the ITK source tree.
26  *
27  *=========================================================================*/
28 #ifndef itkOutputWindow_h
29 #define itkOutputWindow_h
30 
31 #include "itkObject.h"
32 
33 namespace itk
34 {
35 
36 
37 struct OutputWindowGlobals;
38 
48 class ITKCommon_EXPORT OutputWindow : public Object
49 {
50 public:
51  ITK_DISALLOW_COPY_AND_MOVE(OutputWindow);
52 
54  using Self = OutputWindow;
55  using Superclass = Object;
58 
60  itkTypeMacro(OutputWindow, Object);
61 
67  static Pointer
68  New();
69 
71  static Pointer
72  GetInstance();
73 
76  static void
77  SetInstance(OutputWindow * instance);
78 
80  virtual void
81  DisplayText(const char *);
82 
86  virtual void
87  DisplayErrorText(const char * t)
88  {
89  this->DisplayText(t);
90  }
91 
95  virtual void
96  DisplayWarningText(const char * t)
97  {
98  this->DisplayText(t);
99  }
100 
104  virtual void
105  DisplayGenericOutputText(const char * t)
106  {
107  this->DisplayText(t);
108  }
109 
113  virtual void
114  DisplayDebugText(const char * t)
115  {
116  this->DisplayText(t);
117  }
118 
122  itkSetMacro(PromptUser, bool);
123  itkGetConstMacro(PromptUser, bool);
124  itkBooleanMacro(PromptUser);
126 
127 protected:
128  OutputWindow();
129  ~OutputWindow() override;
130  void
131  PrintSelf(std::ostream & os, Indent indent) const override;
132 
133 private:
134  itkGetGlobalDeclarationMacro(OutputWindowGlobals, PimplGlobals);
135 
137  static OutputWindowGlobals * m_PimplGlobals;
138 };
139 } // end namespace itk
140 
141 #endif
itk::OutputWindow
Messages sent from the system are collected by this object.
Definition: itkOutputWindow.h:48
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::OutputWindow::m_PimplGlobals
static OutputWindowGlobals * m_PimplGlobals
Definition: itkOutputWindow.h:137
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:59
itk::OutputWindow::DisplayErrorText
virtual void DisplayErrorText(const char *t)
Definition: itkOutputWindow.h:87
itk::OutputWindow::DisplayGenericOutputText
virtual void DisplayGenericOutputText(const char *t)
Definition: itkOutputWindow.h:105
itkObject.h
itk::OutputWindow::m_PromptUser
bool m_PromptUser
Definition: itkOutputWindow.h:136
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::OutputWindow::DisplayDebugText
virtual void DisplayDebugText(const char *t)
Definition: itkOutputWindow.h:114
itk::OutputWindow::DisplayWarningText
virtual void DisplayWarningText(const char *t)
Definition: itkOutputWindow.h:96
itkGetGlobalDeclarationMacro
#define itkGetGlobalDeclarationMacro(Type, VarName)
Definition: itkSingletonMacro.h:35
itk::Object
Base class for most ITK classes.
Definition: itkObject.h:62