File: sitkEvent.h

package info (click to toggle)
simpleitk 1.0.1-3
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 75,056 kB
  • sloc: cpp: 25,403; python: 3,060; sh: 1,131; ansic: 369; java: 260; cs: 215; makefile: 51; ruby: 47; tcl: 22
file content (72 lines) | stat: -rw-r--r-- 2,223 bytes parent folder | download
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
/*=========================================================================
*
*  Copyright Insight Software Consortium
*
*  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
*
*         http://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 sitkEvent_h
#define sitkEvent_h

#include "sitkCommon.h"
#include <ostream>

namespace itk {
namespace simple {

/** \brief Events which can be observed from ProcessObject.
 *
 * For more information see the page \ref CommandPage.
 */
enum EventEnum {
  /** \brief Occurs for all event types.
   */
  sitkAnyEvent = 0,
  /** \brief Occurs after the process has been aborted, but before exiting the Execute method.
   */
  sitkAbortEvent = 1,
  /** \brief Occurs when the underlying itk::ProcessObject is deleted.
   */
  sitkDeleteEvent = 2,
  /** \brief Occurs at then end of normal processing.
   */
  sitkEndEvent = 3,
  /** \brief Occurs with some algorithms that run for a fixed or undetermined number of iterations.
   */
  sitkIterationEvent = 4,
  /** \brief Occurs when the progress changes in most process objects.
   */
  sitkProgressEvent = 5,
  /** \brief Occurs when then itk::ProcessObject is starting.
   */
  sitkStartEvent = 6,
  /** \brief Occurs when some filters change processing to a different
   * scale
   *
   * \note This event is a sub-event of the more general
   * IterationEvent. The general iteration event will also be invoked.
   */
  sitkMultiResolutionIterationEvent = 9,
  /** \brief Other events may fall into this enumeration.
   */
  sitkUserEvent = 7
};

#ifndef SWIG
SITKCommon_EXPORT std::ostream& operator<<(std::ostream& os, const EventEnum k);
#endif

} // end namespace simple
} // end namespace itk

#endif