mlTreeAndVolumeInputFieldAddOn.h

Go to the documentation of this file.

// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
// **InsertLicense** code
//----------------------------------------------------------------------------------

//----------------------------------------------------------------------------------
#pragma once
 
#include "MLDicomModifySystem.h"
 
// Base class for SringLineFilter
#include <mlFieldAddOnBase.h>
 
// String vector and tools.
#include <mlReleaseTools.h>
 
#include <mlMultiFileVolumeListRefCounted.h>
#include <mlDicomMessageCollector.h>
#include <DCMTree_Lib.h>
 
ML_START_NAMESPACE
 
// Forwards.
class MultiFileVolume;
class MultiFileVolumeList;
class MultiFileVolumeListRefCounted;
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
class ML_DICOM_MODIFY_EXPORT TreeAndVolumeInputFieldAddOn : public FieldAddOnBase
{
public:
  enum InputConfigurations {
    BaseOnly        = 0, 
    ImageBase          , 
    ImageImageBase     , 
    ImageImageImageBase, 
  };

  inline const std::vector<std::string> &getInputSelectorStrings() const { return _inputSelectorEnumerators; }
  
  TreeAndVolumeInputFieldAddOn(Module              &moduleRef,
                               InputConfigurations inputConfig,
                               bool                createFileInput,
                               bool                createMultiFileVolumeCacheInput=false,
                               bool                allowEmptyFileNames=false);

  void                               addFields() override;

  void                               handleFieldActivationChanges() override;

  FieldAddOnBase::FieldChangeState   handleFieldChanges(Field *field) override;

  DCMTree::Const_TreePtr                     getDCMTree(DicomMessageCollector &dcmMsgCollector) const;

  MultiFileVolumeListRefCounted             *getMultiFileVolumeListRefCounted() const;

  const MultiFileVolumeList                 *getMultiFileVolumeList() const;

  const MultiFileVolume                     *getMultiFileVolume() const;

  void                                       setAllowEmptyFileNames(bool allow){ _allowEmptyFileNames = allow; }              

  bool                                       getAllowEmptyFileNames() const { return _allowEmptyFileNames; }              
  
  
  inline InputConnectorField  *getInput0Fld                       () const { return  _input0Fld                       ; }
  inline InputConnectorField  *getInput1Fld                       () const { return  _input1Fld                       ; }
  inline InputConnectorField  *getInput2Fld                       () const { return  _input2Fld                       ; }
  inline BaseField            &getInputBaseFld                    () const { return *_inputBaseFld                    ; }
  inline StringField          *getUnresolvedFileNameFld           () const { return  _unresolvedFileNameFld           ; }
  inline StringField          *getAbsoluteFileNameFld             () const { return  _absoluteFileNameFld             ; }
  inline EnumField            &getInputSelectorFld                () const { return *_inputSelectorFld                ; }
  inline IntField             &getInputVolumeIndexFld             () const { return *_inputVolumeIndexFld             ; }
  inline IntField             &getNumVolumesFld                   () const { return *_numVolumesFld                   ; }
  inline BoolField            &getWarnNonExistingFileOnBrowsingFld() const { return *_warnNonExistingFileOnBrowsingFld; }
  inline BoolField            &getWarnDirectoriesOnBrowsingFld    () const { return *_warnDirectoriesOnBrowsingFld    ; }
  inline size_t                getImageConnector0EnumIndex        () const { return  _imageConnector0EnumIndex        ; }
  inline size_t                getImageConnector1EnumIndex        () const { return  _imageConnector1EnumIndex        ; }
  inline size_t                getImageConnector2EnumIndex        () const { return  _imageConnector2EnumIndex        ; }
  inline size_t                getBaseConnectorEnumIndex          () const { return  _baseConnectorEnumIndex          ; }
  inline size_t                getFileEnumIndex                   () const { return  _fileEnumIndex                   ; }
  inline size_t                getMultiFileVolumeCacheEnumIndex   () const { return  _multiFileVolumeCacheEnumIndex   ; }
  
protected:
  
  void _loadMultiFileVolumeListRefCountedIfNeeded();

  
  Module                    &_module;

  const InputConfigurations _inputConfig;
  
  const bool                _createFileInput;
  
  const bool                _createMultiFileVolumeCacheInput;
  
  
  InputConnectorField       *_input0Fld;
  
  InputConnectorField       *_input1Fld;
  
  InputConnectorField       *_input2Fld;

  BaseField                 *_inputBaseFld;

  StringField               *_unresolvedFileNameFld;

  StringField               *_absoluteFileNameFld;
  
  EnumField                 *_inputSelectorFld;  

  IntField                  *_inputVolumeIndexFld;

  IntField                  *_numVolumesFld;
  
  BoolField               *_warnNonExistingFileOnBrowsingFld;
  
  BoolField               *_warnDirectoriesOnBrowsingFld;

  
  std::vector<std::string>  _inputSelectorEnumerators;
  
  size_t                    _imageConnector0EnumIndex;
  
  size_t                    _imageConnector1EnumIndex;
  
  size_t                    _imageConnector2EnumIndex;
  
  size_t                    _baseConnectorEnumIndex;
  
  size_t                    _fileEnumIndex;
  
  size_t                    _multiFileVolumeCacheEnumIndex;

  MultiFileVolumeListRefCountedPtr _lastLoadedMultiFileVolumeList;
  
  bool                      _allowEmptyFileNames;

  DCMTree::Const_TreePtr    _recentlyLoadedTree;

  DicomMessageCollector     _recentDcmMsgCollector;
  
};
 
ML_END_NAMESPACE