https://mooseframework.inl.gov
DataFileInterface.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #pragma once
11 
12 #include "MooseTypes.h"
13 
14 #include <string>
15 
17 
22 {
23 public:
27  using DataFileParameterType = DataFileName;
28 
33  DataFileInterface(const ParallelParamObject & parent);
34 
41  std::string getDataFileName(const std::string & param) const;
42 
48  std::string getDataFileNameByName(const std::string & relative_path) const;
49 
55  std::string getDataFilePath(const std::string & relative_path) const;
56 
57 private:
59 };
std::string getDataFilePath(const std::string &relative_path) const
Returns the path of a data file for a given relative file path.
Interface for objects that need to resolve data file paths (MooseObject and Action) ...
std::string getDataFileNameByName(const std::string &relative_path) const
Deprecated method.
std::string getDataFileName(const std::string &param) const
Deprecated method.
Base class shared by both Action and MooseObject.
DataFileName DataFileParameterType
The parameter type this interface expects for a data file name.
const ParallelParamObject & _parent
DataFileInterface(const ParallelParamObject &parent)
Constructing the object.