niftkFileHelper.h

Go to the documentation of this file.

/*=============================================================================

  NifTK: A software platform for medical image computing.

  Copyright (c) University College London (UCL). All rights reserved.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.

  See LICENSE.txt in the top level directory for details.

=============================================================================*/

#ifndef niftkFileHelper_h
#define niftkFileHelper_h

#include "niftkCommonWin32ExportHeader.h"

#include <string>
#include <vector>

namespace niftk
{

NIFTKCOMMON_WINEXPORT std::string ConvertToFullNativePath(const std::string& pathName);


NIFTKCOMMON_WINEXPORT std::string Basename(const std::string& pathName);


NIFTKCOMMON_WINEXPORT std::string GetFileSeparator();


NIFTKCOMMON_WINEXPORT std::string ConcatenatePath(const std::string& path, const std::string& name);


NIFTKCOMMON_WINEXPORT bool DirectoryExists(const std::string& directoryPath);


NIFTKCOMMON_WINEXPORT bool CreateDirAndParents(const std::string& directoryPath);


NIFTKCOMMON_WINEXPORT bool FileExists(const std::string& fileName);


NIFTKCOMMON_WINEXPORT bool FileDelete(const std::string& fileName);


NIFTKCOMMON_WINEXPORT bool FileIsEmpty(const std::string& fileName);


NIFTKCOMMON_WINEXPORT int FileSize(const std::string& fileName);


NIFTKCOMMON_WINEXPORT bool FilenameHasPrefixAndExtension(
    const std::string& filename,
    const std::string& prefix,
    const std::string& extension);


NIFTKCOMMON_WINEXPORT bool FilenameMatches(
    const std::string& filename,
    const std::string& prefix,
    const std::string& middle,
    const std::string& extension);


NIFTKCOMMON_WINEXPORT std::string GetImagesDirectory();


NIFTKCOMMON_WINEXPORT std::vector<std::string> GetFilesInDirectory(const std::string& fullDirectoryName);


NIFTKCOMMON_WINEXPORT std::vector<std::string> GetDirectoriesInDirectory(const std::string& fullDirectoryName);


NIFTKCOMMON_WINEXPORT void GetRecursiveFilesInDirectory(
    const std::string& fullDirectoryName, std::vector<std::string> &fileNames);


NIFTKCOMMON_WINEXPORT bool NumericStringCompare(const std::string& string1, const std::string& string2);


NIFTKCOMMON_WINEXPORT std::vector<std::string> FindVideoData(const std::string& directory);


NIFTKCOMMON_WINEXPORT std::string FindVideoFile(const std::string& directory, const std::string& mask = "" );


NIFTKCOMMON_WINEXPORT std::vector<std::string> FindFilesWithGivenExtension(
    const std::string& fullDirectoryName, const std::string& extension);


NIFTKCOMMON_WINEXPORT std::string ExtractImageFileSuffix(const std::string& fileName);


NIFTKCOMMON_WINEXPORT std::string ExtractImageFileSuffix(const std::string& fileName,
                                                         std::string &fileNameWithoutSuffix );


NIFTKCOMMON_WINEXPORT std::string AddStringToImageFileSuffix(const std::string& fileName,
                                                             std::string stringToAdd);


NIFTKCOMMON_WINEXPORT std::string ModifyImageFileSuffix(const std::string& fileName,
                                                        std::string newSuffix );


NIFTKCOMMON_WINEXPORT std::string ModifyFileSuffix(const std::string& fileName,
                                                   std::string newSuffix );
NIFTKCOMMON_WINEXPORT std::string CreateUniqueTempFileName(const std::string &prefix, const std::string &suffix = "");

} // end namespace

#endif