]> Creatis software - bbtk.git/blob - packages/std/src/bbstdFilesFromDirectory.h
f3b8671e3cc67a15ffeaebc4f4af2d14b68b75f7
[bbtk.git] / packages / std / src / bbstdFilesFromDirectory.h
1 /*
2  # ---------------------------------------------------------------------
3  #
4  # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
5  #                        pour la SantÈ)
6  # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
7  # Previous Authors : Laurent Guigues, Jean-Pierre Roux
8  # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
9  #
10  #  This software is governed by the CeCILL-B license under French law and
11  #  abiding by the rules of distribution of free software. You can  use,
12  #  modify and/ or redistribute the software under the terms of the CeCILL-B
13  #  license as circulated by CEA, CNRS and INRIA at the following URL
14  #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
15  #  or in the file LICENSE.txt.
16  #
17  #  As a counterpart to the access to the source code and  rights to copy,
18  #  modify and redistribute granted by the license, users are provided only
19  #  with a limited warranty  and the software's author,  the holder of the
20  #  economic rights,  and the successive licensors  have only  limited
21  #  liability.
22  #
23  #  The fact that you are presently reading this means that you have had
24  #  knowledge of the CeCILL-B license and that you accept its terms.
25  # ------------------------------------------------------------------------ */
26
27
28 #ifndef __bbstdFilesFromDirectory_h_INCLUDED__
29 #define __bbstdFilesFromDirectory_h_INCLUDED__
30 #include "bbtkAtomicBlackBox.h"
31 #include "iostream"
32 #include "bbstd_EXPORT.h"
33
34 namespace bbstd
35 {
36
37   class bbstd_EXPORT FilesFromDirectory
38     : 
39     public bbtk::AtomicBlackBox
40   {
41     BBTK_BLACK_BOX_INTERFACE(FilesFromDirectory,bbtk::AtomicBlackBox);
42     BBTK_DECLARE_INPUT(Active,bool);
43     BBTK_DECLARE_INPUT(In,std::string);
44     BBTK_DECLARE_INPUT(Recursive,bool);  
45     BBTK_DECLARE_INPUT(RecursiveLevel,int);  
46     BBTK_DECLARE_INPUT(Type,int);  
47     BBTK_DECLARE_INPUT(FileEnd,std::vector<std::string>);  
48     BBTK_DECLARE_OUTPUT(Out,std::vector<std::string>);
49     BBTK_DECLARE_OUTPUT(OutSimple,std::vector<std::string>);
50     BBTK_PROCESS(Process);
51     void Process();
52     
53   private :
54     std::string NormalizePath(std::string const &pathname);
55     int         Explore(std::string const &dirpath, bool recursive, int recursiveLevel);
56     void        CleanFilenames( std::string basePath );
57
58     /// List of file names
59     std::vector<std::string> Filenames;
60     std::vector<std::string> SimpleFilenames;
61     /// name of the root directory to explore
62     std::string DirName;
63   };
64   
65   //=================================================================
66   // BlackBox description
67   BBTK_BEGIN_DESCRIBE_BLACK_BOX(FilesFromDirectory,bbtk::AtomicBlackBox);
68    BBTK_NAME("FilesFromDirectory");
69    BBTK_AUTHOR("jpr@creatis.univ-lyon1.fr");
70    BBTK_DESCRIPTION("returns the fullPathNames of the files in a Directory");
71    BBTK_CATEGORY("");
72
73    BBTK_INPUT(FilesFromDirectory,Active,"(default true) Active true/false ",bool,"");
74    BBTK_INPUT(FilesFromDirectory,In,"Directory Name",std::string,"");
75    BBTK_INPUT(FilesFromDirectory,Recursive,"(default false) Recursive directory exploration",bool,"");
76    BBTK_INPUT(FilesFromDirectory,Type,"(0 default) 0=files 1=All_directories 2=last_directories  ",int,"");
77    BBTK_INPUT(FilesFromDirectory,RecursiveLevel,"(999 default) Recursive level",int,"");
78    BBTK_INPUT(FilesFromDirectory,FileEnd,"Select just the files with this end file name",std::vector<std::string>,"");
79   
80    BBTK_OUTPUT(FilesFromDirectory,Out,"FullPathNames of the files",std::vector<std::string>,"");
81    BBTK_OUTPUT(FilesFromDirectory,OutSimple,"Simple Full PathNames of the files",std::vector<std::string>,"");
82
83   BBTK_END_DESCRIBE_BLACK_BOX(FilesFromDirectory);
84
85 }
86 // EO namespace bbstd
87
88 #endif // __bbstdFilesFromDirectory_h_INCLUDED__
89