Options to be passed to getPath(). More...

#include <DataFileUtils.h>

Public Attributes
std::optional< std::string >	base
	The base path by which to search for relative paths. More...

bool	search_all_data = true
	Whether or not to search all registered data. More...

bool	graceful = false
	Whether or not to error whenever a path is not found. More...

Detailed Description

Options to be passed to getPath().

Definition at line 60 of file DataFileUtils.h.

Member Data Documentation

◆ base

std::optional<std::string> Moose::DataFileUtils::GetPathOptions::base

The base path by which to search for relative paths.

This is usually the folder that an input file is in so that paths are searched relative to where that input file is.

Definition at line 65 of file DataFileUtils.h.

Referenced by InputParameters::finalize(), Moose::DataFileUtils::getPath(), and Moose::DataFileUtils::getPathExplicit().

◆ graceful

bool Moose::DataFileUtils::GetPathOptions::graceful = false

Whether or not to error whenever a path is not found.

If this is true, the only time an error is emitted is when an explicit data name is specified and not registered or when an explicit data name is specified and the file was not found within that registered data folder.

Definition at line 72 of file DataFileUtils.h.

Referenced by InputParameters::finalize(), and Moose::DataFileUtils::getPath().

◆ search_all_data

bool Moose::DataFileUtils::GetPathOptions::search_all_data = true

Whether or not to search all registered data.

Definition at line 67 of file DataFileUtils.h.