vtkGlobFileNames.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 vtkGlobFileNames_h
#define vtkGlobFileNames_h

#include "vtkIOCoreModule.h" // For export macro
#include "vtkObject.h"

VTK_ABI_NAMESPACE_BEGIN
class vtkStringArray;

class VTKIOCORE_EXPORT vtkGlobFileNames : public vtkObject
{
public:

  vtkTypeMacro(vtkGlobFileNames, vtkObject);

  static vtkGlobFileNames* New();

  void PrintSelf(ostream& os, vtkIndent indent) override;

  void Reset();


  vtkSetFilePathMacro(Directory);
  vtkGetFilePathMacro(Directory);

  int AddFileNames(VTK_FILEPATH const char* pattern);


  vtkSetMacro(Recurse, vtkTypeBool);
  vtkBooleanMacro(Recurse, vtkTypeBool);
  vtkGetMacro(Recurse, vtkTypeBool);

  int GetNumberOfFileNames();

  VTK_FILEPATH const char* GetNthFileName(int index);


  vtkGetObjectMacro(FileNames, vtkStringArray);

protected:

  vtkSetFilePathMacro(Pattern);
  vtkGetFilePathMacro(Pattern);

  vtkGlobFileNames();
  ~vtkGlobFileNames() override;

private:
  char* Directory;           // Directory for search.
  char* Pattern;             // Wildcard pattern
  vtkTypeBool Recurse;       // Recurse into subdirectories
  vtkStringArray* FileNames; // VTK array of files

  vtkGlobFileNames(const vtkGlobFileNames&) = delete;
  void operator=(const vtkGlobFileNames&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif