FilePathSearch.hpp

Go to the documentation of this file.

/*
Copyright 2007, 2008, 2009, 2010, 2011 Instituto de Sistemas e Robotica, Instituto Superior Tecnico

This file is part of MeRMaID.

MeRMaID is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

MeRMaID is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with MeRMaID.  If not, see <http://www.gnu.org/licenses/>.
*/



/**
 * @Filename FilePathSearch.hpp
 * @Description FilePathSearch declaration
 * @Status Work in Progress
 * @Version $Id: FilePathSearch.hpp 1 2011-03-04 18:13:18Z jreis $
 * @Maintainer Marco Barbosa
 */

#ifndef __SYSTEM_FILEPATHSEARCH_H
#define __SYSTEM_FILEPATHSEARCH_H

#include <list>
#include <string>

namespace mermaid
{
  namespace support
  {
    namespace system
    {
    
      /**
       * @Class FilePathSearch FilePathSearch.hpp "FilePathSearch.hpp"
       * @Description A class providing search for files in known paths
       * @Author Marco Barbosa
       */
      class FilePathSearch
      {
        public:
          static void addSearchPath (std::string path);
          static std::string getFullPathForFile (std::string filename);
          
        private:
          static std::list<std::string> pathList_;
      }; // class FilePathSearch
    } // namespace system
  } // namespace support
} // namespace mermaid


#endif // __SYSTEM_FILEPATHSEARCH_H