mlDicomSeriesAndInstanceReferenceMacroTagInterface.h

Go to the documentation of this file.

// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
// **InsertLicense** code
//----------------------------------------------------------------------------------
 
//----------------------------------------------------------------------------------
#pragma once
 
#include "MLDicomTagInterfacesSystem.h"
#include "mlDicomModifyFieldAddOnBase.h"
#include <DCMTree_DicomTags.h>
 
ML_START_NAMESPACE
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
class MLDICOMTAGINTERFACES_EXPORT DicomSeriesAndInstanceReferenceMacroTagInterface : public DicomModifyFieldAddOnBase 
{
public:
  DicomSeriesAndInstanceReferenceMacroTagInterface(Module &modRef, 
                                                   const std::string &fieldPrefix,
                                                   bool provideCommonInstanceReferenceStudyUIDFld,
                                                   bool provideSeriesInstanceUIDFld=true);
  
  void        addFields() override;
 
  void        inheritValues(DCMTree::Const_TreePtr dcmTree) override;
  
  FieldAddOnBase::FieldChangeState handleFieldChanges(Field *field) override;
 
  std::string applyModifications(DCMTree::TreePtr     dcmTree,
                                 const FieldContainer *treeInfos=nullptr) override;
  
  std::string checkConsistency() const override;
  
  virtual bool        areAllFieldsEmpty() const;
  
  virtual void        clearFields();
  
  virtual void        setMainStudyInstanceUIDInheritance(const std::string &mainStudyInstanceUID, 
                                                         bool inheritOnEquality);
 
  NotifyField  *getClearFieldsFld()                            { return _clearFieldsFld; }
  StringField  *getSeriesInstanceUIDFld()                      { return _seriesInstanceUIDFld; }
  StringField  *getReferencedSOPClassUIDsFld()                 { return _referencedSOPClassUIDsFld; }
  StringField  *getReferencedSOPInstanceUIDsFld()              { return _referencedSOPInstanceUIDsFld; }
  StringField  *getCommonInstanceReferenceStudyInstanceUIDFld(){ return _commonInstanceReferenceStudyInstanceUIDFld; }
  
  static void setUpReferencedSeriesSequence(DCMTree::TreePtr  dcmTree,
                                            const std::string &seriesInstanceUIDValue,
                                            const std::string &referencedSOPClassUIDs,
                                            const std::string &referencedSOPInstanceUIDs,
                                            DCMTree::RawTagId writtenReferencedSeriesSequenceTagId,
                                            DCMTree::RawTagId writtenReferencedInstanceSequenceTagId,
                                            bool              setSeriesInstanceUIDFld);
  
protected:
  const std::string _fieldPrefix;
  
  const bool   _provideCommonInstanceReferenceStudyUIDFld;
  
  const bool   _provideSeriesInstanceUIDFld;
  
  std::string  _mainStudyInstanceUID;
  
  bool         _inheritOnEquality;
  
  NotifyField  *_clearFieldsFld;
  
  // Contents of the Referenced Series Sequence (currently only one entry is supported):
  StringField  *_seriesInstanceUIDFld;
  
  // Contents of the Referenced Series Sequence -> Referenced Instance Sequence:
  StringField  *_referencedSOPClassUIDsFld;
 
  StringField  *_referencedSOPInstanceUIDsFld;
  
  StringField  *_commonInstanceReferenceStudyInstanceUIDFld;
};
 
ML_END_NAMESPACE