vtkPVFileInformationHelper.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkPVFileInformationHelper_h
#define vtkPVFileInformationHelper_h

#include "vtkObject.h"
#include "vtkRemotingCoreModule.h" //needed for exports

#include <string> // needed for std::string

class VTKREMOTINGCORE_EXPORT vtkPVFileInformationHelper : public vtkObject
{
public:
  static vtkPVFileInformationHelper* New();
  vtkTypeMacro(vtkPVFileInformationHelper, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetStringMacro(Path);
  vtkGetStringMacro(Path);


  vtkSetStringMacro(WorkingDirectory);
  vtkGetStringMacro(WorkingDirectory);


  vtkGetMacro(DirectoryListing, int);
  vtkSetMacro(DirectoryListing, int);
  vtkBooleanMacro(DirectoryListing, int);


  vtkGetMacro(SpecialDirectories, int);
  vtkSetMacro(SpecialDirectories, int);
  vtkBooleanMacro(SpecialDirectories, int);


  vtkGetMacro(ExamplesInSpecialDirectories, bool);
  vtkSetMacro(ExamplesInSpecialDirectories, bool);
  vtkBooleanMacro(ExamplesInSpecialDirectories, bool);


  vtkGetMacro(FastFileTypeDetection, int);
  vtkSetMacro(FastFileTypeDetection, int);


  vtkGetMacro(GroupFileSequences, bool);
  vtkSetMacro(GroupFileSequences, bool);
  vtkBooleanMacro(GroupFileSequences, bool);


  vtkGetStringMacro(PathSeparator);

  bool GetActiveFileIsReadable();

  bool GetActiveFileIsDirectory();


  vtkGetMacro(ReadDetailedFileInformation, bool);
  vtkSetMacro(ReadDetailedFileInformation, bool);

protected:
  vtkPVFileInformationHelper();
  ~vtkPVFileInformationHelper() override;

  vtkSetStringMacro(PathSeparator);

  char* Path = nullptr;
  char* WorkingDirectory = nullptr;
  int DirectoryListing = 0;
  int SpecialDirectories = 0;
  int FastFileTypeDetection = 1;
  bool GroupFileSequences = true;
  bool ExamplesInSpecialDirectories = true;

  bool ReadDetailedFileInformation = false;
  char* PathSeparator = nullptr;

private:
  vtkPVFileInformationHelper(const vtkPVFileInformationHelper&) = delete;
  void operator=(const vtkPVFileInformationHelper&) = delete;
};

#endif