Auxiliary.h

Go to the documentation of this file.

 
#ifndef ELEMENTSKERNEL_ELEMENTSKERNEL_AUXILIARY_H_
#define ELEMENTSKERNEL_ELEMENTSKERNEL_AUXILIARY_H_
 
#include <string>  // for string
#include <vector>  // for vector
 
#include "ElementsKernel/Export.h"  // ELEMENTS_API
#include "ElementsKernel/Path.h"    // for Path::Item
 
namespace Elements {
inline namespace Kernel {
 
ELEMENTS_API std::string getAuxiliaryVariableName();
 
template <typename T>
ELEMENTS_API Path::Item getAuxiliaryPath(const T& file_name, bool raise_exception = true);
 
// instantiation of the most expected types
extern template ELEMENTS_API Path::Item getAuxiliaryPath(const Path::Item& file_name, bool raise_exception);
extern template ELEMENTS_API Path::Item getAuxiliaryPath(const std::string& file_name, bool raise_exception);
 
ELEMENTS_API std::vector<Path::Item> getAuxiliaryLocations(bool exist_only = false);
 
namespace Auxiliary {
 
ELEMENTS_API std::string getVariableName();
 
template <typename T>
ELEMENTS_API Path::Item getPath(const T& file_name, bool raise_exception = true);
 
// instantiation of the most expected types
extern template ELEMENTS_API Path::Item getPath(const Path::Item& file_name, bool raise_exception);
extern template ELEMENTS_API Path::Item getPath(const std::string& file_name, bool raise_exception);
 
ELEMENTS_API std::vector<Path::Item> getLocations(bool exist_only = false);
 
}  // namespace Auxiliary
 
}  // namespace Kernel
}  // namespace Elements
 
#define ELEMENTSKERNEL_ELEMENTSKERNEL_AUXILIARY_IMPL_
#include "ElementsKernel/_impl/Auxiliary.tpp"
#undef ELEMENTSKERNEL_ELEMENTSKERNEL_AUXILIARY_IMPL_
 
#endif  // ELEMENTSKERNEL_ELEMENTSKERNEL_AUXILIARY_H_