File: igstkTrackerConfigurationXMLFileReaderBase.h

package info (click to toggle)
igstk 4.4.0-2
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 38,980 kB
  • sloc: cpp: 86,267; xml: 96; makefile: 75; python: 38
file content (199 lines) | stat: -rw-r--r-- 6,247 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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
/*=========================================================================

  Program:   Image Guided Surgery Software Toolkit
  Module:    $RCSfile: igstkTrackerConfigurationXMLFileReaderBase.h,v $
  Language:  C++
  Date:      $Date: 2009-04-27 18:04:49 $
  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 __igstkTrackerConfigurationXMLFileReaderBase_h
#define __igstkTrackerConfigurationXMLFileReaderBase_h

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

namespace igstk
{
/** \class TrackerConfigurationXMLFileReaderBase
 * 
 *  \brief This class is an abstract reader for xml files containing a 
 *         tracker configuration. 
 *
 *         This class is an abstract reader for xml files containing a 
 *         tracker configuration. The specific type of tracker is
 *         defined by the subclass.
 */
class TrackerConfigurationXMLFileReaderBase : public itk::XMLReaderBase 
{
public:

  class UnexpectedTrackerTypeException : public std::exception
  {
  public:
    UnexpectedTrackerTypeException() throw() { };
    virtual ~UnexpectedTrackerTypeException() throw() { };
  };

  /**
   * \class FileFormatException 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 TrackerConfigurationXMLFileReaderBase    Self;
  typedef itk::XMLReaderBase                       Superclass;
  typedef itk::SmartPointer<Self>                  Pointer;
  typedef itk::SmartPointer < const Self >         ConstPointer;

  //run-time type information (and related methods)
  itkTypeMacro( TrackerConfigurationXMLFileReaderBase, 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 configuration 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.
   */
  virtual bool HaveConfigurationData() = 0; 

  /**
   * Return a pointer to the object containing the configuration data.
   */
  virtual const igstk::TrackerConfiguration::Pointer GetTrackerConfigurationData()
    throw ( FileFormatException ) = 0;

protected:
  //this is the constructor that is called by the factory to 
  //create a new object
  TrackerConfigurationXMLFileReaderBase()
    {
    m_ReadingTrackerConfiguration = false;
    m_ReadingToolConfiguration = false;
    m_HaveRefreshRate = false;
    m_ReferenceTool = NULL;
    m_CurrentToolIsReference = false;
    m_CurrentToolCalibration.SetToIdentity( 
    igstk::TimeStamp::GetLongestPossibleTime() );
    }
  virtual ~TrackerConfigurationXMLFileReaderBase() 
    {
    std::vector<TrackerToolConfiguration *>::iterator it = 
      this->m_TrackerToolList.begin();
    std::vector<TrackerToolConfiguration *>::iterator end =  
      this->m_TrackerToolList.end();
    for(; it!=end; it++)
      {
      delete (*it);
      }
    delete m_ReferenceTool;
    }

  igstkObserverMacro( AddToolFailure, 
                      igstk::TrackerConfiguration::AddToolFailureEvent, 
                      std::string );
  
  typedef igstk::PrecomputedTransformData::TransformType* TransformTypePointer;
  igstkObserverMacro( RequestTransform, 
                      igstk::PrecomputedTransformData::TransformTypeEvent, 
                      TransformTypePointer);

  void ProcessTrackingSystemAttributes( const char **atts )
    throw ( FileFormatException, UnexpectedTrackerTypeException );

  void ProcessRefreshRate() throw ( FileFormatException );

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

  void ProcessToolName() throw ( FileFormatException );

  void ProcessToolCalibration() throw ( FileFormatException );
   
  virtual void ProcessToolData() throw ( FileFormatException ) = 0;
  
  virtual double GetMaximalRefreshRate()=0;

  virtual std::string GetSystemType()=0;

  bool m_ReadingTrackerConfiguration;
  bool m_ReadingToolConfiguration;
  bool m_HaveRefreshRate;

  std::string m_CurrentTagData;

  igstk::Transform   m_CurrentToolCalibration;
  std::string        m_CurrentToolName;
  bool               m_CurrentToolIsReference;

  double                                    m_RefreshRate; 
  std::vector<TrackerToolConfiguration *>   m_TrackerToolList;   
  TrackerToolConfiguration *                m_ReferenceTool; 

private:
  TrackerConfigurationXMLFileReaderBase( 
    const TrackerConfigurationXMLFileReaderBase & other );


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


}
#endif //__igstkTrackerConfigurationXMLFileReaderBase_h