https://mooseframework.inl.gov
Public Member Functions | Public Attributes | List of all members
Moose::DataFileUtils::Path Struct Reference

Representation of a data file path. More...

#include <DataFileUtils.h>

Public Member Functions

 Path ()
 
 Path (const std::string &path, const Context context, const std::optional< std::string > &data_name=std::optional< std::string >())
 

Public Attributes

std::string path
 
Context context
 Context for the file (where it came from) More...
 
std::optional< std::string > data_name
 The name of the data registry the file came from (with context == DATA) More...
 

Detailed Description

Representation of a data file path.

Definition at line 36 of file DataFileUtils.h.

Constructor & Destructor Documentation

◆ Path() [1/2]

Moose::DataFileUtils::Path::Path ( )
inline

Definition at line 38 of file DataFileUtils.h.

Context context
Context for the file (where it came from)
Definition: DataFileUtils.h:48
std::optional< std::string > data_name
The name of the data registry the file came from (with context == DATA)
Definition: DataFileUtils.h:50

◆ Path() [2/2]

Moose::DataFileUtils::Path::Path ( const std::string &  path,
const Context  context,
const std::optional< std::string > &  data_name = std::optional<std::string>() 
)
inline

Definition at line 39 of file DataFileUtils.h.

43  {
44  }
Context context
Context for the file (where it came from)
Definition: DataFileUtils.h:48
std::optional< std::string > data_name
The name of the data registry the file came from (with context == DATA)
Definition: DataFileUtils.h:50

Member Data Documentation

◆ context

Context Moose::DataFileUtils::Path::context

Context for the file (where it came from)

Definition at line 48 of file DataFileUtils.h.

Referenced by DataFileInterface::getDataFilePath().

◆ data_name

std::optional<std::string> Moose::DataFileUtils::Path::data_name

The name of the data registry the file came from (with context == DATA)

Definition at line 50 of file DataFileUtils.h.

Referenced by DataFileInterface::getDataFilePath().

◆ path

std::string Moose::DataFileUtils::Path::path

The documentation for this struct was generated from the following file: