Main MRPT website > C++ reference
MRPT logo

CDirectoryExplorer.h

Go to the documentation of this file.
00001 /* +---------------------------------------------------------------------------+
00002    |          The Mobile Robot Programming Toolkit (MRPT) C++ library          |
00003    |                                                                           |
00004    |                   http://mrpt.sourceforge.net/                            |
00005    |                                                                           |
00006    |   Copyright (C) 2005-2011  University of Malaga                           |
00007    |                                                                           |
00008    |    This software was written by the Machine Perception and Intelligent    |
00009    |      Robotics Lab, University of Malaga (Spain).                          |
00010    |    Contact: Jose-Luis Blanco  <jlblanco@ctima.uma.es>                     |
00011    |                                                                           |
00012    |  This file is part of the MRPT project.                                   |
00013    |                                                                           |
00014    |     MRPT is free software: you can redistribute it and/or modify          |
00015    |     it under the terms of the GNU General Public License as published by  |
00016    |     the Free Software Foundation, either version 3 of the License, or     |
00017    |     (at your option) any later version.                                   |
00018    |                                                                           |
00019    |   MRPT is distributed in the hope that it will be useful,                 |
00020    |     but WITHOUT ANY WARRANTY; without even the implied warranty of        |
00021    |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         |
00022    |     GNU General Public License for more details.                          |
00023    |                                                                           |
00024    |     You should have received a copy of the GNU General Public License     |
00025    |     along with MRPT.  If not, see <http://www.gnu.org/licenses/>.         |
00026    |                                                                           |
00027    +---------------------------------------------------------------------------+ */
00028 #ifndef  CDirectoryExplorer_H
00029 #define  CDirectoryExplorer_H
00030 
00031 #include <mrpt/utils/utils_defs.h>
00032 #include <mrpt/system/os.h>
00033 
00034 /*---------------------------------------------------------------
00035         Class
00036   ---------------------------------------------------------------*/
00037 namespace mrpt
00038 {
00039         namespace system
00040         {
00041                 #define FILE_ATTRIB_ARCHIVE             0x0020
00042                 #define FILE_ATTRIB_DIRECTORY   0x0010
00043 
00044                 /** This class allows the enumeration of the files/directories that exist into a given path.
00045                   *  The only existing method is "explore" and returns the list of found files & directories.
00046                   *  Refer to the example in /samples/UTILS/directoryExplorer
00047                   *
00048                   *  \sa CFileSystemWatcher
00049                   */
00050                 class BASE_IMPEXP CDirectoryExplorer
00051                 {
00052                 public:
00053                         /** This represents the information about each file.
00054                           * \sa
00055                           */
00056                         struct BASE_IMPEXP TFileInfo
00057                         {
00058                                 /** The file name (without the whole path).
00059                                   */
00060                                 std::string     name;
00061 
00062                                 /** The whole file path.
00063                                   */
00064                                 std::string     wholePath;
00065 
00066                                 /** Access and modification times.
00067                                   */
00068                                 time_t          accessTime,modTime;
00069 
00070                                 bool            isDir, isSymLink;
00071 
00072                                 /** The size of the file in bytes.
00073                                   */
00074                                 uint64_t                fileSize;
00075                         };
00076 
00077                         /** The list type used in "explore".
00078                           * \sa explore
00079                           */
00080                         typedef std::deque<TFileInfo> TFileInfoList;
00081 
00082                 public:
00083                         /** The path of the directory to examine must be passed to this constructor, among the
00084                           *  According to the following parameters, the object will collect the list of files, which
00085                           *   can be modified later through other methods in this class.
00086                           * \param path The path to examine (IT MUST BE A DIRECTORY), e.g "d:\temp\", or "/usr/include/"
00087                           * \param mask One or the OR'ed combination of the values "FILE_ATTRIB_ARCHIVE" and "FILE_ATTRIB_DIRECTORY", depending on what file types do you want in the list (These values are platform-independent).
00088                           * \param outList The list of found files/directories is stored here.
00089                           * \sa sortByName
00090                           */
00091                         static void explore(
00092                                 const std::string       &path,
00093                                 const unsigned long     mask,
00094                                 TFileInfoList           &outList );
00095 
00096                         /** Sort the file entries by name, in ascending or descending order
00097                           */
00098                         static void sortByName( TFileInfoList &lstFiles, bool ascendingOrder=true );
00099 
00100                         /** Remove from the list of files those whose extension does not coincide (without case) with the given one.
00101                           *  Example:  filterByExtension(lst,"txt");
00102                           */
00103                         static void filterByExtension( TFileInfoList &lstFiles, const std::string &extension  );
00104 
00105                 }; // End of class def.
00106 
00107         } // End of namespace
00108 } // End of namespace
00109 
00110 #endif



Page generated by Doxygen 1.7.3 for MRPT 0.9.4 SVN: at Sat Mar 26 06:40:17 UTC 2011