gdcmCleaner.h

Go to the documentation of this file.

/*=========================================================================
 
  Program: GDCM (Grassroots DICOM). A DICOM library
 
  Copyright (c) 2006-2011 Mathieu Malaterre
  All rights reserved.
  See Copyright.txt or http://gdcm.sourceforge.net/Copyright.html for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef GDCMCLEANER_H
#define GDCMCLEANER_H
 
#include "gdcmDPath.h"
#include "gdcmFile.h"
#include "gdcmSmartPointer.h"
#include "gdcmSubject.h"
 
namespace gdcm {
class GDCM_EXPORT Cleaner : public Subject {
 public:
  Cleaner();
  ~Cleaner() override;
 
  bool Empty(Tag const &t);
  bool Empty(PrivateTag const &pt);
  bool Empty(DPath const &dpath);
  bool Empty(VR const &vr);
 
  bool Remove(Tag const &t);
  bool Remove(PrivateTag const &pt);
  bool Remove(DPath const &dpath);
  bool Remove(VR const &vr);
 
  bool Scrub(Tag const &t);
  bool Scrub(PrivateTag const &pt);
  bool Scrub(DPath const &dpath);
  bool Scrub(VR const &vr);
 
  bool Preserve(DPath const &dpath);
 
  void RemoveAllMissingPrivateCreator(bool remove);
 
  bool RemoveMissingPrivateCreator(Tag const &t);
 
  void RemoveAllGroupLength(bool remove);
 
  void RemoveAllIllegal(bool remove);
 
  void EmptyWhenScrubFails(bool empty);
 
  bool Clean();
 
  void SetFile(const File &f) { F = f; }
  // const File &GetFile() const { return *F; }
  File &GetFile() { return *F; }
 
  static SmartPointer<Cleaner> New() { return new Cleaner; }
 
 private:
  // I would prefer to have a smart pointer to DataSet but DataSet does not
  // derive from Object...
  SmartPointer<File> F;
  struct impl;
  // PIMPL idiom
  impl *pimpl;
};
 
}  // end namespace gdcm
 
#endif  // GDCMCLEANER_H