ProbeXmlConfigParser.h

Go to the documentation of this file.

/*=========================================================================
This file is part of CustusX, an Image Guided Therapy Application.

Copyright (c) 2008-2014, SINTEF Department of Medical Technology
All rights reserved.

Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, 
   this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, 
   this list of conditions and the following disclaimer in the documentation 
   and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors 
   may be used to endorse or promote products derived from this software 
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
=========================================================================*/

#ifndef PROBEXMLCONFIGPARSER_H_
#define PROBEXMLCONFIGPARSER_H_

#include "cxResourceExport.h"

#include <math.h>
#include <vector>
#include <boost/shared_ptr.hpp>
#include <QDomDocument>
#include "cxXmlOptionItem.h"

class cxResource_EXPORT ProbeXmlConfigParser
{
public:
  typedef std::pair<double,double> ColRowPair;
  struct Configuration 
  {
    QString             mUsScanner;  
    QString             mUsProbe;    
    QString             mRtSource;   
    QString             mConfigId;   
    QString             mName;       
    int                     mImageWidth;      
    int                     mImageHeight;     
    double                   mWidthDeg;   
    double                   mDepth;      
    double                   mOffset;     
    double                   mOriginCol;  
    double                   mOriginRow;  
    int                     mNCorners;   
    std::vector<ColRowPair> mCorners;    
    int                     mLeftEdge;   
    int                     mRightEdge;  
    int                     mTopEdge;    
    int                     mBottomEdge; 
    double                  mPixelWidth; 
    double                  mPixelHeight;
    int                     mHorizontalOffset; 
    QString                 mNotes; 
    double                  mTemporalCalibration; 
//    int                     mColumns; ///< X dim
//    int                     mRows;    ///< Y dim
    
    bool mEmpty;
    
    Configuration() :
                mConfigId(""),
        mImageWidth(0),
        mImageHeight(0),
        mWidthDeg(0),
        mDepth(0),
        mOffset(0),
        mOriginCol(0),
        mOriginRow(0),
        mNCorners(0),
        mLeftEdge(0),
        mRightEdge(0),
        mTopEdge(0),
        mBottomEdge(0),
        mPixelWidth(0),
        mPixelHeight(0),
        mHorizontalOffset(0),
        mTemporalCalibration(0),
        mEmpty(true)
    {};
    bool isEmpty(){return mEmpty;};
  };

  //ProbeXmlConfigParser(QString& pathToXml) {}; ///< opens the file and reads it onto the QDomDocument
  //~ProbeXmlConfigParser() {};
  virtual QString getFileName() = 0;
  virtual void removeConfig(QString scanner, QString probe, QString rtsource, QString configId) = 0;
  virtual void saveCurrentConfig(Configuration config) = 0;
  virtual QStringList getScannerList() = 0; 
  virtual QStringList getProbeList(QString scanner) = 0; 
  virtual QStringList getRtSourceList(QString scanner, QString probe) = 0; 
  virtual QStringList getConfigIdList(QString scanner, QString probe, QString rtSource) = 0; 
  virtual Configuration getConfiguration(QString scanner, QString probe, QString rtsource, QString configId) = 0; 

};
typedef boost::shared_ptr<ProbeXmlConfigParser> ProbeXmlConfigParserPtr;

#endif /* PROBEXMLCONFIGPARSER_H_ */