vtkSortFileNames.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkSortFileNames.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm 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 vtkSortFileNames_h
#define vtkSortFileNames_h
 
#include "vtkIOCoreModule.h" // For export macro
#include "vtkObject.h"
 
class vtkStringArray;
 
//BTX
// this is a helper class defined in the .cxx file
class vtkStringArrayVector;
//ETX
 
class VTKIOCORE_EXPORT vtkSortFileNames : public vtkObject
{
public:
 
  vtkTypeMacro(vtkSortFileNames,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);
  static vtkSortFileNames *New();
 
 
  vtkSetMacro(Grouping, int);
  vtkGetMacro(Grouping, int);
  vtkBooleanMacro(Grouping, int);
 
 
  vtkSetMacro(NumericSort, int);
  vtkGetMacro(NumericSort, int);
  vtkBooleanMacro(NumericSort, int);
 
 
  vtkSetMacro(IgnoreCase, int);
  vtkGetMacro(IgnoreCase, int);
  vtkBooleanMacro(IgnoreCase, int);
 
 
  vtkSetMacro(SkipDirectories, int);
  vtkGetMacro(SkipDirectories, int);
  vtkBooleanMacro(SkipDirectories, int);
 
 
  void SetInputFileNames(vtkStringArray *input);
  vtkGetObjectMacro(InputFileNames, vtkStringArray);
 
  virtual vtkStringArray *GetFileNames();
 
  virtual int GetNumberOfGroups();
 
  virtual vtkStringArray *GetNthGroup(int i);
 
  virtual void Update();
 
protected:
  vtkSortFileNames();
  ~vtkSortFileNames();
 
  int NumericSort;
  int IgnoreCase;
  int Grouping;
  int 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&);  // Not implemented.
  void operator=(const vtkSortFileNames&);  // Not implemented.
};
 
#endif