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
|
/*=========================================================================
*
* 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 sitkCommand_h
#define sitkCommand_h
#include "sitkCommon.h"
#include "sitkNonCopyable.h"
#include <set>
namespace itk {
namespace simple {
class ProcessObject;
/** \class Command
* \brief An implementation of the Command design pattern for callback.
*
* This class provides a callback mechanism for event that occur from
* the ProcessObject. These commands can be utilized to observe these
* events.
*
* The Command can be created on the stack, and will automatically
* unregistered it's self when destroyed.
*
* For more information see the page \ref CommandPage.
*/
class SITKCommon_EXPORT Command:
protected NonCopyable
{
public:
/** \brief Default Constructor */
Command();
/** Destructor. */
virtual ~Command(void);
/** Set/Get Command Name */
virtual std::string GetName() const { return this->m_Name; }
virtual void SetName(const std::string &name) { this->m_Name = name; }
/** The method that defines action to be taken by the command */
virtual void Execute(void);
protected:
friend class itk::simple::ProcessObject;
#ifndef SWIG
// internal methods to maintain reference between ProcessObject and
// Command, so when either is destroyed, the other will be notified.
//
// Return value is the number of referenced process objects after
// operation.
virtual size_t AddProcessObject(itk::simple::ProcessObject *o);
virtual size_t RemoveProcessObject(const itk::simple::ProcessObject *o);
virtual void SetOwnedByProcessObjects(bool o) {this->m_OwnedByProcessObjects = o;}
virtual bool GetOwnedByProcessObjects() const {return this->m_OwnedByProcessObjects;}
virtual void OwnedByProcessObjectsOn() {this->SetOwnedByProcessObjects(true);}
virtual void OwnedByProcessObjectsOff() {this->SetOwnedByProcessObjects(false);}
#endif
private:
// a set of objects who use us
std::set<itk::simple::ProcessObject*> m_ReferencedObjects;
bool m_OwnedByProcessObjects;
std::string m_Name;
};
} // end namespace simple
} // end namespace itk
#endif
|
