mlDicomValueInheritAndCreateTagInterface.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 DicomValueInheritAndCreateTagInterface : public DicomModifyFieldAddOnBase 
{
public:
 
  //-----------  
  enum { NumInheritModes = 5 };
  
  enum {
    DoNotInherit=0,      
    InheritFromTopLevel, 
    InheritRecursively,  
    CreateNew,           
    CreateNewIfNeeded    
  };
 
  static const char * const InheritModeStrings[NumInheritModes];
 
  enum { NumAutoCreateValueModes = 3 };
 
  enum {
    DoNotAutoCreate=0,  
    AutoCreateAlways,   
    CreateIfNeeded      
  };
  
  static const char * const AutoCreateValueModeStrings[NumAutoCreateValueModes];
 
  DicomValueInheritAndCreateTagInterface(Module &modRef, 
                                         DCMTree::RawTagId tagId,
                                         const std::string &valueFieldName, /* e.g. "seriesInstanceUID" */
                                         const std::string &fieldSuffix,     /* e.g. "SeriesInstanceUID" */
                                         bool valueIsType1,
                                         const std::string &dicomModuleInfoString, /* e.g. " (General Series)" */
                                         const bool useDefaultField=false,
                                         const std::string &defaultFieldValue=""
                                        );
 
  ~DicomValueInheritAndCreateTagInterface() override;
  
  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 StringField &getValueFld() { return *_valueFld; }
  virtual const StringField &getValueFld() const { return *_valueFld; }
 
  virtual EnumField &getInheritModeFld() { return *_inheritModeFld; }
  virtual const EnumField &getInheritModeFld() const { return *_inheritModeFld; }
 
  virtual StringField *getDefaultFieldFld() { return _defaultFieldFld; }
  virtual const StringField *getDefaultFieldFld() const { return _defaultFieldFld; }
 
  virtual EnumField &getAutoCreateValueFld() { return *_autoCreateValueFld; }
  virtual const EnumField &getAutoCreateValueFld() const { return *_autoCreateValueFld; }
 
  virtual bool isDefaultFieldUsed() const { return _useDefaultField; }
  virtual void setUseDefaultField(bool useDefaultField) { _useDefaultField = useDefaultField; }
 
  virtual NotifyField &getCreateValueFld() { return *_createValueFld; }
  virtual const NotifyField &getCreateValueFld() const { return *_createValueFld; }
 
  virtual void setDefaultCreateFunction(DefaultValueCreatorBase *newDefaultCreator);
 
  virtual const DefaultValueCreatorBase &getDefaultCreateFunction() const;
 
  virtual void createValue();
 
  virtual void createValueIfNeeded();
 
protected:
  StringField *_valueFld;
  
  const DCMTree::RawTagId _tagId;
 
  const std::string _valueFieldName;
 
  const std::string _fieldSuffix;
  
  EnumField   *_inheritModeFld;
  
  EnumField   *_autoCreateValueFld;
  
  NotifyField *_createValueFld;
  
  //-----------  
  const bool _valueIsType1;
 
  const std::string _dicomModuleInfoString;
 
  bool _useDefaultField;
 
  const std::string _defaultInitValue;
 
  StringField *_defaultFieldFld;
 
  DefaultValueCreatorBase *_createDefaultValuePtr;
};
 
ML_END_NAMESPACE