vtkSortFileNames.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSortFileNames_h
#define vtkSortFileNames_h
 
#include "vtkIOCoreModule.h" // For export macro
#include "vtkObject.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkStringArray;
 
// this is a helper class defined in the .cxx file
class vtkStringArrayVector;
 
class VTKIOCORE_EXPORT vtkSortFileNames : public vtkObject
{
public:
  vtkTypeMacro(vtkSortFileNames, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
  static vtkSortFileNames* New();
 
 
  vtkSetMacro(Grouping, vtkTypeBool);
  vtkGetMacro(Grouping, vtkTypeBool);
  vtkBooleanMacro(Grouping, vtkTypeBool);
 
 
  vtkSetMacro(NumericSort, vtkTypeBool);
  vtkGetMacro(NumericSort, vtkTypeBool);
  vtkBooleanMacro(NumericSort, vtkTypeBool);
 
 
  vtkSetMacro(IgnoreCase, vtkTypeBool);
  vtkGetMacro(IgnoreCase, vtkTypeBool);
  vtkBooleanMacro(IgnoreCase, vtkTypeBool);
 
 
  vtkSetMacro(SkipDirectories, vtkTypeBool);
  vtkGetMacro(SkipDirectories, vtkTypeBool);
  vtkBooleanMacro(SkipDirectories, vtkTypeBool);
 
 
  void SetInputFileNames(vtkStringArray* input);
  vtkGetObjectMacro(InputFileNames, vtkStringArray);
 
  virtual vtkStringArray* GetFileNames();
 
  virtual int GetNumberOfGroups();
 
  virtual vtkStringArray* GetNthGroup(int i);
 
  virtual void Update();
 
protected:
  vtkSortFileNames();
  ~vtkSortFileNames() override;
 
  vtkTypeBool NumericSort;
  vtkTypeBool IgnoreCase;
  vtkTypeBool Grouping;
  vtkTypeBool SkipDirectories;
 
  vtkTimeStamp UpdateTime;
 
  vtkStringArray* InputFileNames;
  vtkStringArray* FileNames;
  vtkStringArrayVector* Groups;
 
  virtual void Execute();
 
  virtual void SortFileNames(vtkStringArray* input, vtkStringArray* output);
 
  virtual void GroupFileNames(vtkStringArray* input, vtkStringArrayVector* output);
 
private:
  vtkSortFileNames(const vtkSortFileNames&) = delete;
  void operator=(const vtkSortFileNames&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif