core/fwMedData/include/fwMedData/DicomSeries.hpp

/* ***** BEGIN LICENSE BLOCK *****
 * FW4SPL - Copyright (C) IRCAD, 2009-2018.
 * Distributed under the terms of the GNU Lesser General Public License (LGPL) as
 * published by the Free Software Foundation.
 * ****** END LICENSE BLOCK ****** */

#pragma once

#include "fwMedData/config.hpp"
#include "fwMedData/Series.hpp"
#include "fwMedData/types.hpp"

#include <fwData/factory/new.hpp>

#include <fwMemory/BufferObject.hpp>

#include <boost/filesystem/path.hpp>

fwCampAutoDeclareDataMacro((fwMedData)(DicomSeries), FWMEDDATA_API);

namespace fwMedData
{

class FWMEDDATA_CLASS_API DicomSeries : public ::fwMedData::Series
{

public:

    fwCoreClassDefinitionsWithFactoryMacro( (DicomSeries)(::fwData::Object), (()),
                                            ::fwData::factory::New< DicomSeries >);

    fwCampMakeFriendDataMacro((fwMedData)(DicomSeries));

    typedef std::map < std::size_t, ::fwMemory::BufferObject::sptr > DicomContainerType;

    typedef std::set < std::string > SOPClassUIDContainerType;

    typedef std::map < std::string, std::string > ComputedTagValueContainerType;

    FWMEDDATA_API DicomSeries(::fwData::Object::Key key);

    FWMEDDATA_API virtual ~DicomSeries() override;

    FWMEDDATA_API void shallowCopy( const ::fwData::Object::csptr& _source ) override;

    FWMEDDATA_API void cachedDeepCopy( const ::fwData::Object::csptr& _source, DeepCopyCacheType& cache ) override;

    FWMEDDATA_API void addDicomPath(std::size_t instanceIndex, const ::boost::filesystem::path& path);

    FWMEDDATA_API void addBinary(std::size_t instanceIndex, const ::fwMemory::BufferObject::sptr& buffer);

    FWMEDDATA_API bool isInstanceAvailable(std::size_t instanceIndex) const;

    FWMEDDATA_API void addSOPClassUID(const std::string& sopClassUID);

    FWMEDDATA_API void addComputedTagValue(const std::string& tagName, const std::string& value);

    FWMEDDATA_API bool hasComputedValues(const std::string& tagName) const;

    size_t  getNumberOfInstances () const
    {
        return m_numberOfInstances;
    }
    //------------------------------------------------------------------------------

    void setNumberOfInstances (std::size_t val)
    {
        m_numberOfInstances = val;
    }
    const DicomContainerType& getDicomContainer () const
    {
        return m_dicomContainer;
    }
    //------------------------------------------------------------------------------

    void setDicomContainer (const DicomContainerType& dicomContainer)
    {
        m_dicomContainer = dicomContainer;
    }

    //------------------------------------------------------------------------------

    void clearDicomContainer()
    {
        m_dicomContainer.clear();
    }
    const SOPClassUIDContainerType& getSOPClassUIDs () const
    {
        return m_SOPClassUIDs;
    }
    //------------------------------------------------------------------------------

    void setSOPClassUIDs (const SOPClassUIDContainerType& val)
    {
        m_SOPClassUIDs = val;
    }
    const ComputedTagValueContainerType& getComputedTagValues () const
    {
        return m_computedTagValues;
    }
    //------------------------------------------------------------------------------

    void setComputedTagValues (const ComputedTagValueContainerType& val)
    {
        m_computedTagValues = val;
    }
    std::size_t getFirstInstanceNumber() const
    {
        return m_firstInstanceNumber;
    }

    //------------------------------------------------------------------------------

    void setFirstInstanceNumber(std::size_t firstInstanceNumber)
    {
        m_firstInstanceNumber = firstInstanceNumber;
    }
protected:

    size_t m_numberOfInstances;

    DicomContainerType m_dicomContainer;

    SOPClassUIDContainerType m_SOPClassUIDs;

    ComputedTagValueContainerType m_computedTagValues;

    std::size_t m_firstInstanceNumber;
};

}   //end namespace fwMedData