cxToolFileParser.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 CXTOOLFILEPARSER_H
#define CXTOOLFILEPARSER_H

#include "cxResourceExport.h"

#include <QDomDocument>
#include "cxTransform3D.h"
#include "cxVector3D.h"
#include "cxDefinitions.h"
#include <vector>
#include <map>

namespace cx {

class cxResource_EXPORT ToolFileParser
{
public:
    struct cxResource_EXPORT TrackerInternalStructure
    {
        TRACKING_SYSTEM mType; 
        QString mLoggingFolderName; 
        TrackerInternalStructure() :
                        mType(tsNONE),
                        mLoggingFolderName("")
        {} 
    };

    struct cxResource_EXPORT ToolInternalStructure
    {
        Transform3D getCalibrationAsSSC() const;
        void setCalibration(const Transform3D& cal);
        void saveCalibrationToFile();
        bool verify();

        bool mIsReference;
        bool mIsPointer;
        bool mIsProbe;
//    Tool::Type   mType;                  ///< the tools type
        QString mName; 
        QString mUid; 
        std::vector<QString> mClinicalApplications; 
        TRACKING_SYSTEM mTrackerType; 
        QString mSROMFilename; 
        unsigned int mPortNumber; 
        unsigned int mChannelNumber; 
        std::map<int, Vector3D> mReferencePoints; 
        bool mWireless; 
        bool m5DOF; 
        //TODO use Transform3D instead
        Transform3D mCalibration; 
        QString mCalibrationFilename; 
        QString mGraphicsFileName; 
        QString mPictureFileName; 
        QString mTransformSaveFileName; 
        QString mLoggingFolderName; 
        QString mInstrumentId; 
        QString mInstrumentScannerId; 
        ToolInternalStructure() :
                        mIsReference(false), mIsPointer(false), mIsProbe(false),
                        //mType(Tool::TOOL_NONE),
                        mName(""), mUid(""),
                        mTrackerType(tsNONE), mSROMFilename(""),
                        mPortNumber(UINT_MAX), mChannelNumber(UINT_MAX),
                        mReferencePoints(), mWireless(true),
                        m5DOF(true), mCalibrationFilename(""),
                        mGraphicsFileName(""), mPictureFileName(""),
                        mTransformSaveFileName(""),
                        mLoggingFolderName(""), mInstrumentId(""),
                        mInstrumentScannerId("")
        {}      
    };

public:
    ToolFileParser(QString absoluteToolFilePath, QString loggingFolder = "");
    ~ToolFileParser();

    virtual ToolInternalStructure getTool();

    //static QString getTemplatesAbsoluteFilePath();

protected:
    QDomNode getToolNode(QString toolAbsoluteFilePath);
    Transform3D readCalibrationFile(QString absoluteFilePath);

    QString mToolFilePath; 
    QString mLoggingFolder; 

    QDomDocument mToolDoc; 
    const QString mToolTag, mToolTypeTag, mToolIdTag, mToolNameTag, mToolDescriptionTag, mToolManufacturerTag,
                    mToolClinicalAppTag, mToolGeoFileTag, mToolPicFileTag, mToolDocFileTag, mToolInstrumentTag,
                    mToolInstrumentTypeTag, mToolInstrumentIdTag, mToolInstrumentNameTag,
                    mToolInstrumentManufacturerTag, mToolInstrumentScannerIdTag, mToolInstrumentDescriptionTag,
                    mToolSensorTag, mToolSensorTypeTag, mToolSensorIdTag, mToolSensorNameTag, mToolSensorWirelessTag,
                    mToolSensorDOFTag, mToolSensorPortnumberTag, mToolSensorChannelnumberTag,
                    mToolSensorReferencePointTag, mToolSensorManufacturerTag, mToolSensorDescriptionTag,
                    mToolSensorRomFileTag, mToolCalibrationTag, mToolCalibrationFileTag;

};
}//namespace


#endif // CXTOOLFILEPARSER_H