mlMultiFileVolumeListBaseOutput.h

Go to the documentation of this file.

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

//----------------------------------------------------------------------------------
#pragma once
 
#include "MLMultiFileVolumeListOutputsSystem.h"
 
// ML includes
#include <mlModuleIncludes.h>
 
// List of volumes loaded or accessed via connected module.
#include <mlMultiFileVolumeList.h>

#include <mlMultiFileVolumeListRefCounted.h>
 
// Needed to maintain the DICOM pixel frame-, tag-, and tree caches alife as long as instances of this module exist.
#include <mlDICOMCachedIOProxies.h>
 
// Needed to maintain the DICOM pixel frame-, tag-, and tree caches alife as long as instances of this module exist.
#include <DCMTree_Lib.h>

#include <mlDicomConfigurableMessageFilter.h>
 
ML_START_NAMESPACE
 
// Forward to internally used classes.
class MultiFileVolume;
class DicomTagDumpFieldAddOn;
class RelatedDicomVolumeFieldAddOn;
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
class MLDIRECTDICOMIMPORTOUTPUTS_EXPORT MultiFileVolumeListBaseOutput : public Module
{
public:

  MultiFileVolumeListBaseOutput(int numInputs=0, 
                                int numOutputs=0, 
                                bool autoInstallTagDumpFieldAddOn=true, 
                                bool installInputAccessConnector=true, 
                                bool installInputMessageFilterPlugin=true,
                                bool installOutputAccessConnector=true);

  ~MultiFileVolumeListBaseOutput() override;
 
public:

  virtual void updateToVolume(MultiFileVolume *outVolToUse);

  MultiFileVolume *getCurrentlySetVolume();

  MultiFileVolumeList *getCurrentVolumeList();

  MultiFileVolumeListRefCountedPtr getCurrentVolumeListRefCounted();

  BoolField          &getUseBaseInputFld            () const { return *_useBaseInputFld            ; }
  NotifyField        &getLoadResultCacheFld         () const { return *_loadResultCacheFld         ; }
  BoolField          &getAutoLoadResultCacheFld     () const { return *_autoLoadResultCacheFld     ; }
  StringField        &getCacheFilePathFld           () const { return *_cacheFilePathFld           ; }
  IntField           &getOutVolIdxFld               () const { return *_outVolIdxFld               ; }
  const IntField     &getNumVolumesFld              () const { return *_numVolumesFld              ; }
  const StringField  &getIssuesFld                  () const { return *_issuesFld                  ; }
  const StringField  &getVolumeInfoDumpFld          () const { return *_volumeInfoDumpFld          ; }

  BaseField          *getInputAccessConnectorFld    () const { return  _inputAccessConnectorFld    ; }
  BaseField          *getInputMessageFilterPluginFld() const { return  _inputMessageFilterPluginFld; }
  BaseField          *getOutputAccessConnectorFld   () const { return  _outputAccessConnectorFld   ; }
 
  // Convenience support for FieldAddOns:

  void installDicomTagDumpFieldAddOn();

  DicomTagDumpFieldAddOn* getDicomTagDumpFieldAddOn() const;
  
  void installRelatedDicomVolumeFieldAddOn();

  RelatedDicomVolumeFieldAddOn* getRelatedDicomVolumeFieldAddOn() const;
  
protected:

  void activateAttachments () override;

  void handleNotification (Field *field) override;

  virtual void _updateVolumeInformation(MultiFileVolume *currVol);

  virtual DicomConfigurableMessageFilterBaseRefCountedPtr _getMessageCollector();
 
  // Tool function useful to create text dumps of extracted tag information in derived classes: 
  static std::string extractValueAndAppend(DCMTree::Const_TreePtr dcmTree,
                                           DCMTree::TagId         tagId, 
                                           const std::string      prefixStr, 
                                           std::string            &resultStr,
                                           const std::string      &lineBreakStr="\n");
 
  // Tool function useful to create text dumps of extracted tag information in derived classes: 
  static int extractIntValueAndAppend(DCMTree::Const_TreePtr dcmTree,
                                      DCMTree::TagId         tagId, 
                                      const std::string      prefixStr, 
                                      std::string            &resultStr);
 
  // Tool function useful to create text dumps of extracted tag information in derived classes: 
  static DCMTree::Const_TagPtr extractSequenceAndAppend(DCMTree::Const_TreePtr dcmTree,
                                                        DCMTree::TagId         seqTagId, 
                                                        const std::string      seqNameStr, 
                                                        std::string            &resultStr,
                                                        const std::string      &sep=".");
 
private:


  void _initFieldsAndMembers();

  bool _updateLoadedCache();

  MultiFileVolume *_selectVolumeFromListAndFields();

  //void _clampOutVolIndexField();

  void _updateInformationFields(MultiFileVolume *outVolToUse);


  MLDICOMCachedIOProxies _cacheProxies;

  DicomTagDumpFieldAddOn *_dicomTagDumpFieldAddOn;

  RelatedDicomVolumeFieldAddOn *_relatedDicomVolumeFieldAddOn;
  
  std::string _previousCacheFileContent;

  MultiFileVolumeListRefCountedPtr _outVolumesFromCacheFile;

  MultiFileVolume     *_currOutVolume;
 
  // --------------- User modifiable fields.

  BoolField           *_useBaseInputFld;

  NotifyField         *_loadResultCacheFld;

  BoolField           *_autoLoadResultCacheFld;
  
  StringField         *_cacheFilePathFld;

  BaseField           *_inputAccessConnectorFld;

  BaseField           *_inputMessageFilterPluginFld;
  
  BaseField           *_outputAccessConnectorFld;

  IntField            *_outVolIdxFld;
 
  // --------------- Read-only output information fields
  IntField            *_numVolumesFld;

  StringField         *_issuesFld;

  StringField         *_volumeInfoDumpFld;
  
  NotifyField         *_updateBaseOutputInformationDoneFld;
  
  ML_MODULE_CLASS_HEADER(MultiFileVolumeListBaseOutput);
};
 
 
ML_END_NAMESPACE