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::InstallationPrefixInfo Struct Reference

#include <gromacs/utility/programcontext.h>

Description

Provides information about installation prefix (see IProgramContext::installationPrefix()).

Public Member Functions

 InstallationPrefixInfo (const std::filesystem::path &path, bool bSource)
 Initializes the structure with given values.
 

Public Attributes

std::filesystem::path path_
 Path to the installation prefix of the current GROMACS instance. More...
 
const bool sourceLayoutTreeLike_
 Whether path points to a source tree -like layout. More...
 

Member Data Documentation

std::filesystem::path gmx::InstallationPrefixInfo::path_

Path to the installation prefix of the current GROMACS instance.

If this is NULL or empty, data files cannot be looked up from the install tree and GROMACS functions that access such files may fail. This can also contain a path to the source tree (see bSourceLayout).

const bool gmx::InstallationPrefixInfo::sourceLayoutTreeLike_

Whether path points to a source tree -like layout.

For testing, it is useful to read data files from the source tree. For such cases, the program context can return the source tree root path in path, and set this to true to indicate that the data files should be searched using the layout of the source tree instead of the installation.


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