cxToolFileParser.h

Go to the documentation of this file.

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

Copyright (c) SINTEF Department of Medical Technology.
All rights reserved.

CustusX is released under a BSD 3-Clause license.

See Lisence.txt (https://github.com/SINTEFMedtek/CustusX/blob/master/License.txt) for details.
=========================================================================*/

#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<QString, 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; 
                QString mOpenigtlinkImageId; 
                QString mOpenigtlinkTransformId; 
                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),
                        mCalibration(Transform3D::Identity()),
                        mCalibrationFilename(""),
                        mGraphicsFileName(""), mPictureFileName(""),
                        mTransformSaveFileName(""),
                        mLoggingFolderName(""), mInstrumentId(""),
                        mInstrumentScannerId("")
                {}      
        };

        typedef boost::shared_ptr<ToolInternalStructure> ToolInternalStructurePtr;

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

        virtual ToolInternalStructurePtr 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,
        mToolOpenigtlinkImageIdTag, mToolOpenigtlinkTransformIdTag;

};
}//namespace


#endif // CXTOOLFILEPARSER_H