Mantid
Loading...
Searching...
No Matches
Public Attributes | List of all members
MantidQt::API::FindFilesSearchParameters Struct Reference

POD struct to hold details about the parameters of a file search. More...

#include <FindFilesWorker.h>

Public Attributes

std::string algorithmName
 The name of the algorithm to load files with. More...
 
std::string algorithmProperty
 The name of the property on the algorithm to use for searching. More...
 
std::vector< std::string > extensions
 any additional extensions that we want to consider More...
 
bool isForRunFiles
 Whether the search is for experimental run data. More...
 
bool isOptional
 Whether the search is optional (i.e. a failed search means no error). More...
 
std::string searchText
 The text to use as a hint to search for files. More...
 

Detailed Description

POD struct to hold details about the parameters of a file search.

This is built by the thread pool manager and passed to the worker thread which uses the information to find files and build a FindFilesSearchResult

Definition at line 27 of file FindFilesWorker.h.

Member Data Documentation

◆ algorithmName

std::string MantidQt::API::FindFilesSearchParameters::algorithmName

◆ algorithmProperty

std::string MantidQt::API::FindFilesSearchParameters::algorithmProperty

The name of the property on the algorithm to use for searching.

Definition at line 37 of file FindFilesWorker.h.

Referenced by MantidQt::API::FileFinderWidget::createFindFilesSearchParameters(), MantidQt::API::FindFilesWorker::getFilesFromAlgorithm(), and MantidQt::API::FindFilesWorker::run().

◆ extensions

std::vector<std::string> MantidQt::API::FindFilesSearchParameters::extensions

any additional extensions that we want to consider

Definition at line 39 of file FindFilesWorker.h.

Referenced by MantidQt::API::FileFinderWidget::createFindFilesSearchParameters(), and MantidQt::API::FindFilesWorker::run().

◆ isForRunFiles

bool MantidQt::API::FindFilesSearchParameters::isForRunFiles

Whether the search is for experimental run data.

Definition at line 31 of file FindFilesWorker.h.

Referenced by MantidQt::API::FileFinderWidget::createFindFilesSearchParameters(), and MantidQt::API::FindFilesWorker::run().

◆ isOptional

bool MantidQt::API::FindFilesSearchParameters::isOptional

Whether the search is optional (i.e. a failed search means no error).

Definition at line 33 of file FindFilesWorker.h.

Referenced by MantidQt::API::FileFinderWidget::createFindFilesSearchParameters(), and MantidQt::API::FindFilesWorker::run().

◆ searchText

std::string MantidQt::API::FindFilesSearchParameters::searchText

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