File: igstkTransformXMLFileReaderBase.h

package info (click to toggle)
igstk 4.2.0-3
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 36,940 kB
  • ctags: 6,895
  • sloc: cpp: 70,958; makefile: 99; xml: 70
file content (185 lines) | stat: -rw-r--r-- 5,041 bytes parent folder | download | duplicates (2)
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
/*=========================================================================

  Program:   Image Guided Surgery Software Toolkit
  Module:    $RCSfile: igstkTransformXMLFileReaderBase.h,v $
  Language:  C++
  Date:      $Date: 2009-03-26 18:53:02 $
  Version:   $Revision: 1.2 $

  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 __igstkTransformXMLFileReaderBase_h
#define __igstkTransformXMLFileReaderBase_h

#include <itkXMLFile.h>
#include "igstkPrecomputedTransformData.h"


namespace igstk
{
/** \class TransformXMLFileReaderBase
 * 
 *  \brief This class is an abstract reader for xml files containing a 
 *         precomputed transformation. The specific type of transformation is
 *         defined by the subclass.
 *
 *  This class is the base class for all the readers that load a precomputed
 *  transformation. 
 *
 *  The xml file format is as follows:
    @verbatim
    <precomputed_transform>
   
    <description>
       Claron bayonet probe calibration
    </description>
   
    <computation_date>
       Thursday July 4 12:00:00 1776
    </computation_date>
   
    <transformation estimation_error="0.5">
       your parameters go here
    </transformation>
     
   </precomputed_transform>
   @endverbatim
 *
 * 
 */
class TransformXMLFileReaderBase : public itk::XMLReaderBase 
{
public:
  /**
   * \class This is the exception that is thrown if there is a problem with the
   * file format (does not follow the expected format).
   */
  class FileFormatException : public std::exception
    {
    public:
    /**
     * Construct an exception with a specifc message.
     */
    FileFormatException(const std::string &errorMessage) 
      {
      this->m_ErrorMessage = errorMessage;
      }

    /**
     * Virtual destructor.
     */
    virtual ~FileFormatException() throw() {}

    /**
     * Get the error message.
     */
    virtual const char* what() const throw() 
      {
      return m_ErrorMessage.c_str();
      }
    private:
    std::string m_ErrorMessage;
    };

  //standard typedefs
  typedef TransformXMLFileReaderBase    Self;
  typedef itk::XMLReaderBase            Superclass;
  typedef itk::SmartPointer<Self>       Pointer;

           //run-time type information (and related methods)
  itkTypeMacro( TransformXMLFileReaderBase, itk::XMLReaderBase );


  /**
   * Check that the given name isn't a zero length string, that the file exists,
   * and that it isn't a directory.
   */
  virtual int CanReadFile(const char* name);

  /**
   * Method called when a new xml tag start is encountered.
   */
  virtual void StartElement( const char * name, const char **atts ); 

  /**
   * Method called when an xml tag end is encountered.
   */
  virtual void EndElement( const char *name ); 

  /**
   * Method for handling the data inside an xml tag.
   */
  virtual void CharacterDataHandler( const char *inData, int inLength );

  /**
   * Method for checking if the transformation data has been read. When the xml 
   * file is empty or doesn't contain the relevant tags the read operation is 
   * successful, but we don't have the information we need.
   */
  bool HaveTransformData();

  /**
   * Return a pointer to the object containing the transform data.
   */
  igstk::PrecomputedTransformData::Pointer GetTransformData(); 

protected:
          //this is the constructor that is called by the factory to 
         //create a new object
  TransformXMLFileReaderBase() {
    m_ReadingTransformData = false;
    m_HaveDescription = false;
    m_HaveDate = false;
    m_HaveTransform = false;
    m_HaveError = false;
    m_ReadingTagData = false;
    m_Transform = NULL;
    }
  virtual ~TransformXMLFileReaderBase() { delete m_Transform; }

  void ProcessDescription() 
  throw ( FileFormatException );

  void ProcessDate() 
  throw ( FileFormatException );
 
  virtual void ProcessTransformation() 
  throw (FileFormatException ) = 0;

  void ProcessTransformationAttributes( const char ** atts )
  throw ( FileFormatException );


  bool m_ReadingTransformData;
  bool m_ReadingTagData;
  bool m_HaveDescription;
  bool m_HaveDate;
  bool m_HaveTransform;
  bool m_HaveError;

  
  std::string m_CurrentTagData;

  std::string                               m_Description;
  PrecomputedTransformData::DateType        m_Date;
  PrecomputedTransformData::ErrorType       m_EstimationError;
  PrecomputedTransformData::TransformType*  m_Transform; 

private:
  TransformXMLFileReaderBase( 
    const TransformXMLFileReaderBase & other );


  const TransformXMLFileReaderBase & operator=( 
    const TransformXMLFileReaderBase & right );
};


}
#endif //__igstkTransformXMLFileReaderBase_h