-// gdcmDirList.h
-//-----------------------------------------------------------------------------
+/*=========================================================================
+
+ Program: gdcm
+ Module: $RCSfile: gdcmDirList.h,v $
+ Language: C++
+ Date: $Date: 2004/10/12 04:35:45 $
+ Version: $Revision: 1.11 $
+
+ 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 <string>
#include <list>
+namespace gdcm
+{
//-----------------------------------------------------------------------------
-class GDCM_EXPORT gdcmDirList: public std::list<std::string>
+/**
+ * \ingroup DirList
+ * \brief List containing the file headers from root directory.
+ */
+class GDCM_EXPORT DirList: public std::list<std::string>
{
public :
- gdcmDirList(std::string dirName,bool recursive=false);
- virtual ~gdcmDirList(void);
+ DirList(std::string dirName,bool recursive=false);
+ virtual ~DirList();
- std::string GetDirName(void);
+ std::string GetDirName();
-/// \
+ /// Character '\'
static const char SEPARATOR_X;
-/// /
-static const char SEPARATOR_WIN;
-/// depending on the O.S.
+ /// Character '/'
+ static const char SEPARATOR_WIN;
+ /// depending on the O.S.
static const std::string SEPARATOR;
private :
- void Explore(std::string dirName,bool recursive=false);
-/// name of the root directory to explore
+ int Explore(std::string dirName,bool recursive=false);
+ /// name of the root directory to explore
std::string name;
};
-
+} // end namespace gdcm
//-----------------------------------------------------------------------------
#endif