Mantid::Kernel::MultiFileNameParsing::GenerateFileName Class Reference

A functor that generates a vector of file names from the given vector of runs, and other state passed to it when constructed. More...

#include <MultiFileNameParser.h>

Public Member Functions
	GenerateFileName (std::string prefix, std::string suffix, std::string instString)
	Constructor. More...
std::vector< std::string >	operator() (const std::vector< unsigned int > &runs)
	Overloaded function operator that generates a vector of file names from a vector of runs. More...
std::string	operator() (unsigned int run)
	Overloaded function operator that generates a file name from a run. More...

Private Attributes
std::string	m_instString
	String that identifies the instrument. More...
std::string	m_prefix
	String that prefixes any generated file names. More...
std::string	m_suffix
	String that suffixes any generated file names. More...

Detailed Description

A functor that generates a vector of file names from the given vector of runs, and other state passed to it when constructed.

Definition at line 119 of file MultiFileNameParser.h.

Constructor & Destructor Documentation

GenerateFileName()

Mantid::Kernel::MultiFileNameParsing::GenerateFileName::GenerateFileName	(	std::string	prefix,
		std::string	suffix,
		std::string	instString
	)

Constructor.

Constructor, to accept state used in generating file names.

Parameters

prefix	:: a string that prefixes the generated file names.
suffix	:: a string that suffixes the generated file names.
instString	:: the instrument name

Definition at line 356 of file MultiFileNameParser.cpp.

Member Function Documentation

operator()() [1/2]

std::vector< std::string > Mantid::Kernel::MultiFileNameParsing::GenerateFileName::operator()

(

const std::vector< unsigned int > &

runs

)

Overloaded function operator that generates a vector of file names from a vector of runs.

Overloaded function operator that takes in a vector of runs, and returns a vector of file names.

Parameters

runs	:: the vector of runs with which to make file names.

Returns

the generated vector of file names.

Definition at line 367 of file MultiFileNameParser.cpp.

operator()() [2/2]

std::string Mantid::Kernel::MultiFileNameParsing::GenerateFileName::operator()

(

unsigned int

run

)

Overloaded function operator that generates a file name from a run.

Overloaded function operator that takes in a runs, and returns a file name.

Parameters

run	:: the vector of runs with which to make file names.

Returns

the generated vector of file names.

Definition at line 384 of file MultiFileNameParser.cpp.

References m_instString, m_prefix, and m_suffix.

Member Data Documentation

m_instString

std::string Mantid::Kernel::MultiFileNameParsing::GenerateFileName::m_instString

private

String that identifies the instrument.

Definition at line 136 of file MultiFileNameParser.h.

Referenced by operator()().

m_prefix

std::string Mantid::Kernel::MultiFileNameParsing::GenerateFileName::m_prefix

private

String that prefixes any generated file names.

Definition at line 132 of file MultiFileNameParser.h.

Referenced by operator()().

m_suffix

std::string Mantid::Kernel::MultiFileNameParsing::GenerateFileName::m_suffix

private

String that suffixes any generated file names.

Definition at line 134 of file MultiFileNameParser.h.

Referenced by operator()().

---

The documentation for this class was generated from the following files:

• Framework/Kernel/inc/MantidKernel/MultiFileNameParser.h
• Framework/Kernel/src/MultiFileNameParser.cpp