]> Creatis software - gdcm.git/blob - src/gdcmDirList.h
Coding Style + Doxygenation
[gdcm.git] / src / gdcmDirList.h
1 /*=========================================================================
2                                                                                 
3   Program:   gdcm
4   Module:    $RCSfile: gdcmDirList.h,v $
5   Language:  C++
6   Date:      $Date: 2005/01/06 20:03:27 $
7   Version:   $Revision: 1.14 $
8                                                                                 
9   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
10   l'Image). All rights reserved. See Doc/License.txt or
11   http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
12                                                                                 
13      This software is distributed WITHOUT ANY WARRANTY; without even
14      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15      PURPOSE.  See the above copyright notices for more information.
16                                                                                 
17 =========================================================================*/
18
19 #ifndef GDCMDIRLIST_H
20 #define GDCMDIRLIST_H
21
22 #include "gdcmCommon.h"
23
24 #include <string>
25 #include <list>
26
27 namespace gdcm 
28 {
29
30 //-----------------------------------------------------------------------------
31 /**
32  * \ingroup DirList
33  * \brief   List containing the file headers from root directory. 
34  */
35 // NOTE: Due to a VC6 'feature' we can not export a std::list in a dll, 
36 // so GDCM_EXPORT keyword was removed for this class only
37
38 class DirList: public std::list<std::string>
39 {
40 public :
41    DirList(std::string const &dirName, bool recursive=false);
42    virtual ~DirList();
43
44    std::string const &GetDirName() const;
45
46    /// Character '\' 
47    static const char SEPARATOR_X;
48    /// Character '/'  
49    static const char SEPARATOR_WIN;
50    /// depending on the O.S.
51    static const std::string SEPARATOR;
52
53 private :
54    int Explore(std::string const &dirName, bool recursive=false);
55
56    /// name of the root directory to explore
57    std::string name;
58 };
59 } // end namespace gdcm
60 //-----------------------------------------------------------------------------
61 #endif