cxDicomModelNode.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 CXDICOMMODELNODE_H
#define CXDICOMMODELNODE_H

#include "org_custusx_dicom_Export.h"

#include "boost/shared_ptr.hpp"
#include <vector>
#include "cxDICOMModel.h"
#include "ctkDICOMDatabase.h"
#include "cxDicomImageReader.h"

namespace cx
{
typedef boost::shared_ptr<class DicomModelNode> NodePtr;


class org_custusx_dicom_EXPORT DicomModelNode
{
public:
        static NodePtr createNode(int row, DicomModelNode* parent, QSharedPointer<ctkDICOMDatabase> dataBase);
        static NodePtr getNullNode();

        DicomModelNode();
        virtual ~DicomModelNode() {}

        bool canFetchMore() const;
        bool hasChildren() const;
        NodePtr getFetchedChildForRow(int row) const;

        virtual DICOMModel::IndexType getType() const = 0;
        virtual void fillChildrenUids() = 0;
        virtual QVariant getName() const { return QVariant(); }
        virtual QVariant getTimestamp() const { return QVariant(); }
        virtual QVariant getModality() const { return QVariant(); }
        virtual QVariant getImageCount() const { return QVariant(); }

        QVariant getDefaultName() const { return "No description"; }
        QString format_date() const { return "yyyy-MM-dd"; }
        QString format_time() const { return "hh:mm"; }

        DicomImageReaderPtr createReader() const;
        virtual QString getFirstDICOMFilename() const { return ""; }
        QString getUid() const { return UID; }
        int getRow() const;
        DicomModelNode* getParent() const { return Parent; }
        const std::vector<NodePtr>& getFetchedChildren() const { return FetchedChildren; }  
        QStringList getChildrenUID() const { return ChildrenUID; } 
        void removeChild(int index);

        QVariant getValue(int column) const;
        QStringList getHeaders() const;
        bool isNull() const { return this->getType()==DICOMModel::NoneType; }

protected:
        QVariant getUncachedValue(int column) const;

        DicomModelNode*                 Parent;
        std::vector<NodePtr>            FetchedChildren; 
        QStringList                     ChildrenUID; 
//      int                             Row;
        QString                         UID;
        mutable std::map<int, QVariant> CachedValues;
        QSharedPointer<ctkDICOMDatabase> DataBase;
        static NodePtr NullNode;
};


class org_custusx_dicom_EXPORT NullDicomModelNode : public DicomModelNode
{
public:
        NullDicomModelNode() {}
        virtual ~NullDicomModelNode() {}

        virtual DICOMModel::IndexType getType() const { return DICOMModel::NoneType; }
        virtual void fillChildrenUids() {}
};

class org_custusx_dicom_EXPORT RootDicomModelNode : public DicomModelNode
{
public:
        RootDicomModelNode() {}
        virtual ~RootDicomModelNode() {}

        virtual DICOMModel::IndexType getType() const { return DICOMModel::RootType; }
        virtual void fillChildrenUids();
};


class org_custusx_dicom_EXPORT PatientDicomModelNode : public DicomModelNode
{
public:
        PatientDicomModelNode() {}
        virtual ~PatientDicomModelNode() {}

        virtual DICOMModel::IndexType getType() const { return DICOMModel::PatientType; }
        virtual void fillChildrenUids();
        virtual QVariant getName() const;
        virtual QVariant getTimestamp() const;
        virtual QString getFirstDICOMFilename() const;
};

class org_custusx_dicom_EXPORT StudyDicomModelNode : public DicomModelNode
{
public:
        StudyDicomModelNode() {}
        virtual ~StudyDicomModelNode() {}

        virtual DICOMModel::IndexType getType() const { return DICOMModel::StudyType; }
        virtual void fillChildrenUids();
        virtual QVariant getName() const;
        virtual QVariant getTimestamp() const;
        virtual QString getFirstDICOMFilename() const;
};

class org_custusx_dicom_EXPORT SeriesDicomModelNode : public DicomModelNode
{
public:
        SeriesDicomModelNode() {}
        virtual ~SeriesDicomModelNode() {}

        virtual DICOMModel::IndexType getType() const { return DICOMModel::SeriesType; }
        virtual void fillChildrenUids() {}
        virtual QVariant getName() const;
        virtual QVariant getTimestamp() const;
        virtual QVariant getModality() const;
        virtual QVariant getImageCount() const;
        virtual QString getFirstDICOMFilename() const;
        int getFrameCountForSeries(QString series) const;
};

} // namespace cx

#endif // CXDICOMMODELNODE_H