Gromacs  2024.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Public Attributes
gmx::DataFileInfo Struct Reference

#include <gromacs/utility/include/gromacs/utility/datafilefinder.h>

Description

Information about a data file found by DataFileFinder::enumerateFiles().

Public Member Functions

 DataFileInfo (const std::filesystem::path &dir, const std::filesystem::path &name, bool bDefault)
 Initializes the structure with given values.
 

Public Attributes

std::filesystem::path dir_
 Directory from which the file was found. More...
 
std::filesystem::path name_
 Name of the file without any directory name.
 
bool fromDefaultDir_
 Whether the file was found from the default directory. More...
 

Member Data Documentation

std::filesystem::path gmx::DataFileInfo::dir_

Directory from which the file was found.

If the file was found from the current directory, this will be ".". In other cases, this will be a full path (except if the user-provided search path contains relative paths).

bool gmx::DataFileInfo::fromDefaultDir_

Whether the file was found from the default directory.

If true, the file was found from the default installation data directory, not from the current directory or any user-provided (through DataFileFinder::setSearchPathFromEnv()) location.

Todo:
Consider replacing with an enum that identifies the source (current dir, GMXLIB, default).

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