Elements 6.3.1
A C++ base framework for the Euclid Software.
Loading...
Searching...
No Matches
Auxiliary.h
Go to the documentation of this file.
1
34#ifndef ELEMENTSKERNEL_ELEMENTSKERNEL_AUXILIARY_H_
35#define ELEMENTSKERNEL_ELEMENTSKERNEL_AUXILIARY_H_
36
37#include <string> // for string
38#include <vector> // for vector
39
40#include "ElementsKernel/Export.h" // ELEMENTS_API
41#include "ElementsKernel/Path.h" // for Path::Item
42
43namespace Elements {
44inline namespace Kernel {
45
53
54template <typename T>
55ELEMENTS_API Path::Item getAuxiliaryPath(const T& file_name, bool raise_exception = true);
56
57// instantiation of the most expected types
58extern template ELEMENTS_API Path::Item getAuxiliaryPath(const Path::Item& file_name, bool raise_exception);
59extern template ELEMENTS_API Path::Item getAuxiliaryPath(const std::string& file_name, bool raise_exception);
60
62
63namespace Auxiliary {
64
70ELEMENTS_API std::string getVariableName();
71
81template <typename T>
82ELEMENTS_API Path::Item getPath(const T& file_name, bool raise_exception = true);
83
84// instantiation of the most expected types
85extern template ELEMENTS_API Path::Item getPath(const Path::Item& file_name, bool raise_exception);
86extern template ELEMENTS_API Path::Item getPath(const std::string& file_name, bool raise_exception);
87
94
95} // namespace Auxiliary
96
101} // namespace Kernel
102} // namespace Elements
103
104#define ELEMENTSKERNEL_ELEMENTSKERNEL_AUXILIARY_IMPL_
105#include "ElementsKernel/_impl/Auxiliary.tpp" // IWYU pragma: export
106#undef ELEMENTSKERNEL_ELEMENTSKERNEL_AUXILIARY_IMPL_
107
108#endif // ELEMENTSKERNEL_ELEMENTSKERNEL_AUXILIARY_H_
109
implementation of the templates declared in ElementsKernel/Auxiliary.h
defines the macros to be used for explicit export of the symbols
provide functions to retrieve resources pointed by environment variables
ELEMENTS_API Path::Item getPath(const T &file_name, bool raise_exception=true)
alias for the getAuxiliaryPath function
ELEMENTS_API std::string getAuxiliaryVariableName()
retrieve the variable name used for the auxiliary file lookup
Definition Auxiliary.cpp:41
#define ELEMENTS_API
Dummy definitions for the backward compatibility mode.
Definition Export.h:74
ELEMENTS_API std::vector< Path::Item > getLocations(bool exist_only=false)
alias for the getAuxiliaryLocations function
Definition Auxiliary.cpp:80
boost::filesystem::path Item
Definition Path.h:57
ELEMENTS_API std::vector< Path::Item > getAuxiliaryLocations(bool exist_only=false)
Definition Auxiliary.cpp:49
ELEMENTS_API Path::Item getAuxiliaryPath(const T &file_name, bool raise_exception=true)