mlDicomBoolInheritAndWriteTagInterface.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"
 
ML_START_NAMESPACE
 
// Forwards.
struct DefaultValueCreatorBase;
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
class MLDICOMTAGINTERFACES_EXPORT DicomBoolInheritAndWriteTagInterface : public DicomModifyFieldAddOnBase
{
public:
 
  //-----------  
  enum { NumInheritModes = 3 };
  
  enum InheritMode {
    DoNotInherit=0,      
    InheritFromTopLevel, 
    InheritRecursively   
  };
 
  static const char * const InheritModeStrings[NumInheritModes];
 
  DicomBoolInheritAndWriteTagInterface(Module &modRef,
                                       const DCMTree::RawTagId tagId,               /* e.g. DCMTree_BurnedInAnnotation */
                                       const std::string &valueFieldName,           /* e.g. "burnedInAnnotation" */
                                       const std::string &fieldSuffix,              /* e.g. "BurnedInAnnotation" */
                                       const std::string &dicomModuleInfoString="", /* e.g. " (Enhanced MR Image)" */
                                       const bool valueFldDefault=false,
                                       const bool writeFldDefault=false,
                                       const InheritMode inheritModeFldDefault=InheritFromTopLevel,
                                       const bool defaultFldDefault=false,
                                       const bool updateWriteOnInheritFldDefault=true,
                                       const bool alwaysWrite=false
                                      );
  
  void        addFields() override;
  
  void        inheritValues(DCMTree::Const_TreePtr dcmTree) override;
  
  std::string applyModifications(DCMTree::TreePtr     dcmTree,
                                 const FieldContainer *treeInfos=nullptr) override;
 
  FieldAddOnBase::FieldChangeState handleFieldChanges(Field *field) override;
 
  std::string checkConsistency() const override;
 
  virtual BoolField &getValueFld() { return *_valueFld; }
  virtual const BoolField &getValueFld() const { return *_valueFld; }
 
  virtual BoolField &getWriteFld() { return *_writeFld; }
  virtual const BoolField &getWriteFld() const { return *_writeFld; }
 
  virtual EnumField &getInheritModeFld() { return *_inheritModeFld; }
  virtual const EnumField &getInheritModeFld() const { return *_inheritModeFld; }
 
  virtual BoolField &getDefaultValueFld() { return *_defaultValueFld; }
  virtual const BoolField &getDefaultValueFld() const { return *_defaultValueFld; }
 
  virtual BoolField &getUpdateWriteOnInheritFld() { return *_updateWriteOnInheritFld; }
  virtual const BoolField &getUpdateWriteOnInheritFld() const { return *_updateWriteOnInheritFld; }
 
protected:
  const DCMTree::RawTagId _tagId;
 
  const std::string _valueFieldName;
 
  const std::string _fieldSuffix;
 
  const std::string _dicomModuleInfoString;
 
  const bool _valueFldDefault;
 
  const bool _writeFldDefault;
 
  const InheritMode _inheritModeFldDefault;
 
  const bool _defaultValueFldDefault;
 
  const bool _updateWriteOnInheritFldDefault;
 
  BoolField *_valueFld;
 
  BoolField *_writeFld;
 
  EnumField *_inheritModeFld;
 
  BoolField *_defaultValueFld;
 
  BoolField *_updateWriteOnInheritFld;
 
  const bool _alwaysWrite;
};
 
ML_END_NAMESPACE