/*=========================================================================
                                                                                
  Program:   gdcm
  Module:    $RCSfile: gdcmDirList.h,v $
  Language:  C++
  Date:      $Date: 2005/02/01 09:46:15 $
  Version:   $Revision: 1.21 $
                                                                                
  Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  l'Image). All rights reserved. See Doc/License.txt or
  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.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 notices for more information.
                                                                                
=========================================================================*/

#ifndef GDCMDIRLIST_H
#define GDCMDIRLIST_H

#include "gdcmCommon.h"

#include <string>
#include <vector>
#include <iostream>

namespace gdcm 
{

typedef std::vector<std::string> DirListType;

//-----------------------------------------------------------------------------

// NOTE: Due to a VC6 'feature' we can not export a std::list in a dll, 
// so GDCM_EXPORT keyword was removed for this class only

/**
 * \ingroup DirList
 * \brief   List containing the file headers of all the gdcm readable files
 *          found by exploring recursively a root directory. 
 */
class GDCM_EXPORT DirList
{
public :
   DirList(std::string const &dirName, bool recursive=false);
   ~DirList();

   /// Return the name of the directory
   std::string const &GetDirName() const { return DirName; }

   /// Return the file names
   DirListType const &GetFilenames() const { return Filenames; };

   /// Print all element of the DirList
   void Print(std::ostream &os = std::cout);

   static bool IsDirectory(std::string const &dirName);

private :
   int Explore(std::string const &dirName, bool recursive=false);

   DirListType Filenames;

   /// name of the root directory to explore
   std::string DirName;
};
} // end namespace gdcm
//-----------------------------------------------------------------------------
#endif