LArFileHelper.h

Go to the documentation of this file.

/**
 *  @file   larpandoracontent/LArHelpers/LArFileHelper.h
 *
 *  @brief  Header file for the file helper class
 *
 *  $Log: $
 */
#ifndef LAR_FILE_HELPER_H
#define LAR_FILE_HELPER_H 1

#include <string>

namespace lar_content
{

/**
 *  @brief  LArFileHelper class
 */
class LArFileHelper
{
public:
    /**
     *  @brief  Find the fully-qualified file name by searching through a list of delimiter-separated paths in a named environment
     *          variable. The fully-qualified file name will be provided for the first instance of the file name encountered.
     *
     *  @param  unqualifiedFileName the unqualified file name
     *  @param  environmentVariable the name of the environment variable specifying a list of delimiter-separated paths
     *  @param  delimiter the specified delimiter
     *
     *  @return the fully-qualified name if found, else a StatusCode exception will be raised
     */
    static std::string FindFileInPath(const std::string &unqualifiedFileName, const std::string &environmentVariable, const std::string &delimiter = ":");
};

} // namespace lar_content

#endif // #ifndef LAR_FILE_HELPER_H