mlFileListFilterPluginBase.h

Go to the documentation of this file.

// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
// **InsertLicense** code
//----------------------------------------------------------------------------------
 
//----------------------------------------------------------------------------------
#pragma once
 
// Local includes
#include "MLFileListToolsSystem.h"
 
// ML includes
#include <mlModuleIncludes.h>
 
// Collecting messages during calls.
#include "mlFilterMessage.h"
 
// DCMTree prototypes.
#include <DCMTree_Lib.h>
 
ML_START_NAMESPACE
 
// Forward to internally used classes.
namespace FileListTools {
  class FileAttribute;
}
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
class MLFILE_LIST_TOOLS_EXPORT FileListFilterPluginBase : public Module
{
public:
 
  typedef std::map< std::string, FileListTools::FileAttribute > FileAttributeMap;
 
 
  FileListFilterPluginBase(int numIns=0, int numOuts=0);
 
  virtual const FileListFilterPluginBase* getConnectedInputFilterPlugin() const;
 
  virtual void filterFile(FileListTools::FileAttribute &filterAttributes) const;
 
  virtual void filterFile(FileListTools::FileAttribute &filterAttributes,
                          FilterMessageList            *messageList) const;
 
  virtual void postFilterAll(FileAttributeMap &filterAttributeMap) const;
 
  virtual void postFilterAll(FileAttributeMap  &filterAttributeMap,
                             FilterMessageList *messageList) const;
 
  inline BaseField &getInputFilterPluginFld  () const { return *_inputFilterPluginFld ; }
  inline BaseField &getOutputFilterPluginFld () const { return *_outputFilterPluginFld; }
  
protected:
 
  void handleNotification(Field *field) override;
 
  virtual BaseField &_getInputFilterPluginFld()    { return *_inputFilterPluginFld; }
 
  virtual BaseField &_getOutputFilterPluginFld()   { return *_outputFilterPluginFld; }
 
  virtual void       _touchOutputFilterPluginFld() { _outputFilterPluginFld->touch(); }
 
  virtual void       _callInputFileFilter(FileListTools::FileAttribute &filterAttributes,
                                          FilterMessageList            *messageList=nullptr) const;
 
  virtual void       _callInputPostFilter(FileAttributeMap  &filterAttributeMap,
                                          FilterMessageList *messageList=nullptr) const;
 
private:
  BaseField *_inputFilterPluginFld;
 
  BaseField *_outputFilterPluginFld;
 
  ML_MODULE_CLASS_HEADER(FileListFilterPluginBase);
};
 
typedef FileListFilterPluginBase DirectDicomImportImportFilterPluginBase; 
 
ML_END_NAMESPACE