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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
/*=========================================================================
Program: Image Guided Surgery Software Toolkit
Module: $RCSfile: igstkTransformFileReader.h,v $
Language: C++
Date: $Date: 2009-01-30 20:49:54 $
Version: $Revision: 1.1 $
Copyright (c) ISC Insight Software Consortium. All rights reserved.
See IGSTKCopyright.txt or http://www.igstk.org/copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef __igstkTransformFileReader_h
#define __igstkTransformFileReader_h
#include "igstkStateMachine.h"
#include "igstkTransformXMLFileReaderBase.h"
#include "igstkPrecomputedTransformData.h"
#include "igstkMacros.h"
#include "igstkObject.h"
namespace igstk
{
/** \class TransformFileReader
*
* \brief This class is an IGSTK wrapper for all readers of xml files
* containing a precomputed transformation.
* The specific type of transformation is defined by the actual reader
* specified with the RequestSetReader() method.
*
*/
class TransformFileReader : public Object
{
public:
/**Macro with standard traits declarations (Self, SuperClass, state machine
* etc.). */
igstkStandardClassTraitsMacro( TransformFileReader, Object )
/** This is the container type which holds all the data associated with the
* transformation (transformation, computation time...).*/
typedef PrecomputedTransformData TransformDataType;
/**
* Set a specific reader, which also defines the type of transformation.
*/
void RequestSetReader( TransformXMLFileReaderBase::Pointer transformReader );
/**
* Set the file name from which the data is loaded.
*/
void RequestSetFileName( const std::string &fileName );
/**
* Actually perform the read operation. This method generates a
* ReadSuccessEvent upon success and a ReadFailureEvent if reading failed. If
* the reader hasn't been initialized yet (missing file name or xml reader)
* an InvalidRequestErrorEvent is generated.
*/
void RequestRead();
/**
* Get the transformation data. This method generates a TransformDataEvent if
* the data was loaded, otherwise an InvalidRequestErrorEvent.
*/
void RequestGetData();
/** This event is generated when the transformation data is requested and the
* data is available. */
igstkLoadedEventMacro( TransformDataEvent, IGSTKEvent,
TransformDataType::Pointer );
/** This event is generated if setting the xml reader succeeded. */
igstkEventMacro( SetReaderSuccessEvent, IGSTKEvent );
/** This event is generated if setting the xml reader failed. */
igstkEventMacro( SetReaderFailureEvent, IGSTKErrorEvent );
/** This event is generated if setting the file name succeeded. */
igstkEventMacro( SetFileNameSuccessEvent, IGSTKEvent );
/** This event is generated if setting the file name failed. */
igstkEventMacro( SetFileNameFailureEvent, IGSTKErrorEvent );
/** This event is generated if setting the file name succeeded. */
igstkEventMacro( ReadSuccessEvent, IGSTKEvent );
/** This event is generated if setting the file name failed. */
igstkLoadedEventMacro( ReadFailureEvent, IGSTKErrorEvent,
EventHelperType::StringType );
/** \class Class that observes the events generated by the transform
reader. */
class ReadObserver : public itk::Command
{
public:
typedef ReadObserver Self;
typedef ::itk::Command Superclass;
typedef ::itk::SmartPointer<Self> Pointer;
typedef ::itk::SmartPointer<const Self> ConstPointer;
igstkNewMacro( Self )
igstkTypeMacro( ReadObserver, itk::Command )
virtual void Execute( itk::Object *caller,
const itk::EventObject & event )
{
const igstk::TransformFileReader::ReadFailureEvent *rfe;
if( ( rfe =
dynamic_cast<const igstk::TransformFileReader::ReadFailureEvent *>
( &event ) ) )
{
m_ErrorMessage = rfe->Get();
m_ErrorOcured = true;
}
else if(
dynamic_cast<const igstk::TransformFileReader::ReadSuccessEvent *>
( &event ) )
{
( static_cast<igstk::TransformFileReader *>
( caller ) )->RequestGetData();
}
}
bool GotReadFailure() const
{
return m_ErrorOcured;
}
void Reset()
{
m_ErrorOcured = false;
}
std::string GetErrorMessage() const
{
return m_ErrorMessage;
}
virtual void Execute( const itk::Object *caller,
const itk::EventObject & event )
{
const itk::Object * constCaller = caller;
this->Execute( constCaller, event );
}
protected:
ReadObserver()
{
m_ErrorOcured = false;
}
virtual ~ReadObserver(){}
private:
//purposely not implemented
ReadObserver(const Self&);
void operator=(const Self&);
std::string m_ErrorMessage;
bool m_ErrorOcured;
};
protected:
TransformFileReader( void );
virtual ~TransformFileReader( void );
/** Print the object information in a stream. */
void PrintSelf( std::ostream& os, itk::Indent indent ) const;
private:
/** List of state machine states */
igstkDeclareStateMacro( Idle );
igstkDeclareStateMacro( AttemptingSetFileName );
igstkDeclareStateMacro( AttemptingSetReader );
igstkDeclareStateMacro( FileNameSet );
igstkDeclareStateMacro( ReaderSet );
igstkDeclareStateMacro( AttemptingSetReaderHaveFileName );
igstkDeclareStateMacro( AttemptingSetFileNameHaveReader );
igstkDeclareStateMacro( Initialized );
igstkDeclareStateMacro( AttemptingRead );
igstkDeclareStateMacro( HaveData );
/** List of state machine inputs */
igstkDeclareInputMacro( SetReader );
igstkDeclareInputMacro( SetFileName );
igstkDeclareInputMacro( Read );
igstkDeclareInputMacro( GetData );
igstkDeclareInputMacro( Success );
igstkDeclareInputMacro( Failure );
/**List of state machine actions*/
void ReportInvalidRequestProcessing();
void SetReaderProcessing();
void ReportSetReaderSuccessProcessing();
void ReportSetReaderFailureProcessing();
void SetFileNameProcessing();
void ReportSetFileNameSuccessProcessing();
void ReportSetFileNameFailureProcessing();
void ReadProcessing();
void ReportReadSuccessProcessing();
void ReportReadFailureProcessing();
void GetDataProcessing();
TransformDataType::Pointer m_TransformData;
TransformXMLFileReaderBase::Pointer m_TmpXMLFileReader;
TransformXMLFileReaderBase::Pointer m_XMLFileReader;
std::string m_TmpFileName;
std::string m_FileName;
//if reading fails the ReadProcessing() method updates this string
//with an appropriate error message which the user recieves when
//the ReportReadFailureProcessing() generates the ReadFailureEvent
EventHelperType::StringType m_ReadFailureErrorMessage;
};
}
#endif //__igstkTransformFileReader_h
|
