core/fwMedData/include/fwMedData/Series.hpp

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

#ifndef __FWMEDDATA_SERIES_HPP__
#define __FWMEDDATA_SERIES_HPP__

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

#include <fwData/factory/new.hpp>
#include <fwData/Object.hpp>

fwCampAutoDeclareDataMacro((fwMedData)(Series), FWMEDDATA_API);

namespace fwMedData
{

class Patient;
class Study;
class Equipment;

class FWMEDDATA_CLASS_API Series : public ::fwData::Object
{

public:
    fwCoreNonInstanciableClassDefinitionsMacro( (Series)(::fwData::Object) );

    fwCampMakeFriendDataMacro((fwMedData)(Series));

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

    FWMEDDATA_API virtual ~Series();

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

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

    SPTR(::fwMedData::Patient) getPatient() const;
    void setPatient(const SPTR(::fwMedData::Patient)& val);
    SPTR(::fwMedData::Study) getStudy() const;
    void setStudy(const SPTR(::fwMedData::Study)& val);
    SPTR(::fwMedData::Equipment) getEquipment() const;
    void setEquipment(const SPTR(::fwMedData::Equipment)& val);
    const DicomValueType& getInstanceUID () const;
    void setInstanceUID (const DicomValueType& val);
    const DicomValueType& getModality () const;
    void setModality (const DicomValueType& val);
    const DicomValueType& getDate () const;
    void setDate (const DicomValueType& val);
    const DicomValueType& getTime () const;
    void setTime (const DicomValueType& val);
    const DicomValueType& getDescription () const;
    void setDescription (const DicomValueType& val);
    const DicomValuesType& getPerformingPhysiciansName () const;
    void setPerformingPhysiciansName (const DicomValuesType& val);
protected:

    SPTR(Patient) m_patient;

    SPTR(Study) m_study;

    SPTR(Equipment) m_equipment;

    DicomValueType m_instanceUID;

    DicomValueType m_modality;

    DicomValueType m_date;

    DicomValueType m_time;

    DicomValueType m_description;

    DicomValuesType m_performingPhysiciansName;
};

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

inline SPTR(::fwMedData::Patient) Series::getPatient() const
{
    return m_patient;
}

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

inline void Series::setPatient(const SPTR(::fwMedData::Patient)& val)
{
    m_patient = val;
}

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

inline SPTR(::fwMedData::Study) Series::getStudy() const
{
    return m_study;
}

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

inline void Series::setStudy(const SPTR(::fwMedData::Study)& val)
{
    m_study = val;
}

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

inline SPTR(::fwMedData::Equipment) Series::getEquipment() const
{
    return m_equipment;
}

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

inline void Series::setEquipment(const SPTR(::fwMedData::Equipment)& val)
{
    m_equipment = val;
}

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

inline const DicomValueType& Series::getInstanceUID () const
{
    return m_instanceUID;
}

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

inline void Series::setInstanceUID (const DicomValueType& val)
{
    m_instanceUID = val;
}

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

inline const DicomValueType& Series::getModality () const
{
    return m_modality;
}

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

inline void Series::setModality (const DicomValueType& val)
{
    m_modality = val;
}

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

inline const DicomValueType& Series::getDate () const
{
    return m_date;
}

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

inline void Series::setDate (const DicomValueType& val)
{
    m_date = val;
}

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

inline const DicomValueType& Series::getTime () const
{
    return m_time;
}

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

inline void Series::setTime (const DicomValueType& val)
{
    m_time = val;
}

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

inline const DicomValueType& Series::getDescription () const
{
    return m_description;
}

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

inline void Series::setDescription (const DicomValueType& val)
{
    m_description = val;
}

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

inline const DicomValuesType& Series::getPerformingPhysiciansName () const
{
    return m_performingPhysiciansName;
}

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

inline void Series::setPerformingPhysiciansName (const DicomValuesType& val)
{
    m_performingPhysiciansName = val;
}

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

}   //end namespace fwMedData

#endif // __FWMEDDATA_SERIES_HPP__