cxDataInterface.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 CXDATAINTERFACE_H_
#define CXDATAINTERFACE_H_

#include "cxGuiExport.h"
#include "cxDoublePropertyBase.h"
#include "cxStringPropertyBase.h"
#include "cxForwardDeclarations.h"
#include "cxCoordinateSystemHelpers.h"


namespace cx
{
typedef boost::shared_ptr<class ActiveImageProxy> ActiveImageProxyPtr;
typedef boost::shared_ptr<class ActiveToolProxy> ActiveToolProxyPtr;

class cxGui_EXPORT DoublePropertyActiveToolOffset : public DoublePropertyBase
{
        Q_OBJECT
public:
        static boost::shared_ptr<DoublePropertyActiveToolOffset> create(ActiveToolProxyPtr activeTool)
        {
                return boost::shared_ptr<DoublePropertyActiveToolOffset>(new DoublePropertyActiveToolOffset(activeTool));
        }

        DoublePropertyActiveToolOffset(ActiveToolProxyPtr activeTool);
        virtual ~DoublePropertyActiveToolOffset() {}
        virtual QString getDisplayName() const { return "Offset"; }
        virtual QString getHelp() const
        {
                return "Tool tip virtual offset, in mm.";
        }
        virtual double getValue() const;
        virtual bool setValue(double val);
        virtual void connectValueSignals(bool on) {}
        DoubleRange getValueRange() const;

protected:
        ActiveToolProxyPtr mActiveTool;
};

class cxGui_EXPORT DoublePropertyToolOffset : public DoublePropertyBase
{
        Q_OBJECT
public:
        static boost::shared_ptr<DoublePropertyToolOffset> create(ToolPtr tool)
        {
                return boost::shared_ptr<DoublePropertyToolOffset>(new DoublePropertyToolOffset(tool));
        }

        DoublePropertyToolOffset(ToolPtr tool);
        virtual ~DoublePropertyToolOffset() {}
        virtual QString getDisplayName() const { return "Offset"; }
        virtual QString getHelp() const
        {
                return "Tool tip virtual offset, in mm.";
        }
        virtual double getValue() const;
        virtual bool setValue(double val);
        virtual void connectValueSignals(bool on) {}
        DoubleRange getValueRange() const;

        void setTool(ToolPtr tool);

protected:
        ToolPtr mTool;
};

class cxGui_EXPORT DoublePropertyActiveImageBase : public DoublePropertyBase
{
        Q_OBJECT
public:
        DoublePropertyActiveImageBase(ActiveDataPtr activeData);
        virtual ~DoublePropertyActiveImageBase() {}
        virtual double getValue() const;
        virtual bool setValue(double val);
        virtual void connectValueSignals(bool on) {}
private slots:
        void activeImageChanged();
protected:
        virtual double getValueInternal() const = 0;
        virtual void setValueInternal(double val) = 0;

        ImagePtr mImage;
        ActiveImageProxyPtr mActiveImageProxy;
        ActiveDataPtr mActiveData;
};

class cxGui_EXPORT DoubleProperty2DWindow : public DoublePropertyActiveImageBase
{
public:
        virtual ~DoubleProperty2DWindow() {}
        virtual QString getDisplayName() const { return "Window"; }
        virtual double getValueInternal() const;
        virtual void setValueInternal(double val);
        virtual DoubleRange getValueRange() const;
};

class cxGui_EXPORT DoubleProperty2DLevel : public DoublePropertyActiveImageBase
{
        Q_OBJECT
public:
        virtual ~DoubleProperty2DLevel() {}
        virtual QString getDisplayName() const { return "Level"; }
        virtual double getValueInternal() const;
        virtual void setValueInternal(double val);
        virtual DoubleRange getValueRange() const;
};

typedef boost::shared_ptr<class StringPropertyParentFrame> StringPropertyParentFramePtr;

class cxGui_EXPORT StringPropertyParentFrame : public StringPropertyBase
{
        Q_OBJECT
public:
        static StringPropertyParentFramePtr New(PatientModelServicePtr patientModelService) { return StringPropertyParentFramePtr(new StringPropertyParentFrame(patientModelService)); }
        StringPropertyParentFrame(PatientModelServicePtr patientModelService);
        void setData(DataPtr data);
        virtual ~StringPropertyParentFrame();

public: // basic methods
        virtual QString getDisplayName() const;
        virtual bool setValue(const QString& value);
        virtual QString getValue() const;

public: // optional methods
        virtual QString getHelp() const;
        virtual QStringList getValueRange() const;
        virtual QString convertInternal2Display(QString internal);

protected:
        DataPtr mData;
        PatientModelServicePtr mPatientModelService;
};

typedef boost::shared_ptr<class StringPropertySetParentFrame> StringPropertySetParentFramePtr;

class cxGui_EXPORT StringPropertySetParentFrame : public StringPropertyParentFrame
{
        Q_OBJECT
public:
        static StringPropertySetParentFramePtr New(PatientModelServicePtr patientModelService) { return StringPropertySetParentFramePtr(new StringPropertySetParentFrame(patientModelService)); }
        StringPropertySetParentFrame(PatientModelServicePtr patientModelService);
        virtual ~StringPropertySetParentFrame() {}
public: // basic methods
        virtual bool setValue(const QString& value);
};


typedef boost::shared_ptr<class StringPropertyDataNameEditable> StringPropertyDataNameEditablePtr;

class cxGui_EXPORT StringPropertyDataNameEditable : public StringPropertyBase
{
        Q_OBJECT
public:
        static StringPropertyDataNameEditablePtr New() { return StringPropertyDataNameEditablePtr(new StringPropertyDataNameEditable()); }
        StringPropertyDataNameEditable();
        virtual void setData(DataPtr data);
        virtual ~StringPropertyDataNameEditable() {}

public: // basic methods
        virtual QString getDisplayName() const;
        virtual bool setValue(const QString& value);
        virtual QString getValue() const;

        virtual bool isReadOnly() const { return false; }
        virtual bool getAllowOnlyValuesInRange() const { return false; }


private:
        DataPtr mData;
};

typedef boost::shared_ptr<class StringPropertyDataUidEditable> StringPropertyDataUidEditablePtr;

class cxGui_EXPORT StringPropertyDataUidEditable : public StringPropertyBase
{
        Q_OBJECT
public:
        static StringPropertyDataUidEditablePtr New() { return StringPropertyDataUidEditablePtr(new StringPropertyDataUidEditable()); }
        StringPropertyDataUidEditable();
        virtual void setData(DataPtr data);
        virtual ~StringPropertyDataUidEditable() {}

public: // basic methods
        virtual QString getDisplayName() const;
        virtual bool setValue(const QString& value);
        virtual QString getValue() const;

        virtual bool isReadOnly() const { return true; }
        virtual bool getAllowOnlyValuesInRange() const { return false; }

private:
        DataPtr mData;
};
typedef boost::shared_ptr<class StringPropertyDataModality> StringPropertyDataModalityPtr;

class cxGui_EXPORT StringPropertyDataModality : public StringPropertyBase
{
        Q_OBJECT
public:
        static StringPropertyDataModalityPtr New(PatientModelServicePtr patientModelService) { return StringPropertyDataModalityPtr(new StringPropertyDataModality(patientModelService)); }
        StringPropertyDataModality(PatientModelServicePtr patientModelService);
        virtual ~StringPropertyDataModality();
        void setData(ImagePtr data);

public: // basic methods
        virtual QString getDisplayName() const;
        virtual bool setValue(const QString& value);
        virtual QString getValue() const;

public: // optional methods
        virtual QString getHelp() const;
        virtual QStringList getValueRange() const;

protected:
        ImagePtr mData;
        PatientModelServicePtr mPatientModelService;
};

typedef boost::shared_ptr<class StringPropertyImageType> StringPropertyImageTypePtr;

class cxGui_EXPORT StringPropertyImageType : public StringPropertyBase
{
        Q_OBJECT
public:
        static StringPropertyImageTypePtr New(PatientModelServicePtr patientModelService) { return StringPropertyImageTypePtr(new StringPropertyImageType(patientModelService)); }
        StringPropertyImageType(PatientModelServicePtr patientModelService);
        void setData(ImagePtr data);
        virtual ~StringPropertyImageType();

public: // basic methods
        virtual QString getDisplayName() const;
        virtual bool setValue(const QString& value);
        virtual QString getValue() const;

public: // optional methods
        virtual QString getHelp() const;
        virtual QStringList getValueRange() const;

protected:
        ImagePtr mData;
        PatientModelServicePtr mPatientModelService;
};


typedef boost::shared_ptr<class StringPropertyGlyphOrientationArray> StringPropertyGlyphOrientationArrayPtr;

class cxGui_EXPORT StringPropertyGlyphOrientationArray : public StringPropertyBase
{
        Q_OBJECT
public:
        static StringPropertyGlyphOrientationArrayPtr New(PatientModelServicePtr patientModelService) { return StringPropertyGlyphOrientationArrayPtr(new StringPropertyGlyphOrientationArray(patientModelService)); }
        StringPropertyGlyphOrientationArray(PatientModelServicePtr patientModelService);
        virtual ~StringPropertyGlyphOrientationArray();
        void setData(MeshPtr data);

public: // basic methods
        virtual QString getDisplayName() const;
        virtual bool setValue(const QString& value);
        virtual QString getValue() const;

public: // optional methods
        virtual QString getHelp() const;
        virtual QStringList getValueRange() const;

protected:
        MeshPtr mData;
        PatientModelServicePtr mPatientModelService;
};


typedef boost::shared_ptr<class StringPropertyGlyphColorArray> StringPropertyGlyphColorArrayPtr;

class cxGui_EXPORT StringPropertyGlyphColorArray : public StringPropertyBase
{
        Q_OBJECT
public:
        static StringPropertyGlyphColorArrayPtr New(PatientModelServicePtr patientModelService) { return StringPropertyGlyphColorArrayPtr(new StringPropertyGlyphColorArray(patientModelService)); }
        StringPropertyGlyphColorArray(PatientModelServicePtr patientModelService);
        virtual ~StringPropertyGlyphColorArray();
        void setData(MeshPtr data);

public: // basic methods
        virtual QString getDisplayName() const;
        virtual bool setValue(const QString& value);
        virtual QString getValue() const;

public: // optional methods
        virtual QString getHelp() const;
        virtual QStringList getValueRange() const;

protected:
        MeshPtr mData;
        PatientModelServicePtr mPatientModelService;
};



typedef boost::shared_ptr<class StringPropertyGlyphLUT> StringPropertyGlyphLUTPtr;

class cxGui_EXPORT StringPropertyGlyphLUT : public StringPropertyBase
{
        Q_OBJECT
public:
        static StringPropertyGlyphLUTPtr New(PatientModelServicePtr patientModelService) { return StringPropertyGlyphLUTPtr(new StringPropertyGlyphLUT(patientModelService)); }
        StringPropertyGlyphLUT(PatientModelServicePtr patientModelService);
        virtual ~StringPropertyGlyphLUT();
        void setData(MeshPtr data);

public: // basic methods
        virtual QString getDisplayName() const;
        virtual bool setValue(const QString& value);
        virtual QString getValue() const;

public: // optional methods
        virtual QString getHelp() const;
        virtual QStringList getValueRange() const;

protected:
        MeshPtr mData;
        PatientModelServicePtr mPatientModelService;
};


} // namespace cx


#endif /* CXDATAINTERFACE_H_ */