FIAMSScheduler Class Reference

#include <OpenMS/ANALYSIS/ID/FIAMSScheduler.h>

Collaboration diagram for FIAMSScheduler:

Public Member Functions
	FIAMSScheduler ()=default
	FIAMSScheduler (String filename, String base_dir="/", String output_dir="/", bool load_cached_=true)
	Default constructor.
	~FIAMSScheduler ()=default
	Default destructor.
	FIAMSScheduler (const FIAMSScheduler &cp)=default
	Copy constructor.
FIAMSScheduler &	operator= (const FIAMSScheduler &fdp)=default
	Assignment.
void	run ()
	Run the FIA-MS data analysis for the batch defined in the filename_.
const std::vector< std::map< String, String > > &	getSamples ()
	Get the batch.
const String &	getBaseDir ()
	Get the base directory for the relevant paths from the csv file.
const String &	getOutputDir ()
	Get the output directory for the results.

Private Member Functions
void	loadSamples_ ()
	Load the batch from the csv file and store as the vector of maps.

Private Attributes
String	filename_
String	base_dir_
String	output_dir_
bool	load_cached_
std::vector< std::map< String, String > >	samples_

Constructor & Destructor Documentation

FIAMSScheduler() [1/3]

FIAMSScheduler ( )

default

FIAMSScheduler() [2/3]

FIAMSScheduler	(	String	filename,
		String	base_dir = "/",
		String	output_dir = "/",
		bool	load_cached_ = true
	)

Default constructor.

Parameters

filename	full path to the csv file
base_dir	base directory, where subdirectories within the CSV are located; must include a trailing slash at the end of the directory
output_dir	output dir for results; must include a trailing slash at the end of the directory
load_cached_	load the cached results if they exist

~FIAMSScheduler()

~FIAMSScheduler ( )

default

Default destructor.

FIAMSScheduler() [3/3]

FIAMSScheduler ( const FIAMSScheduler &  cp )

default

Copy constructor.

Member Function Documentation

getBaseDir()

const String & getBaseDir

(

)

Get the base directory for the relevant paths from the csv file.

getOutputDir()

const String & getOutputDir

(

)

Get the output directory for the results.

getSamples()

const std::vector< std::map< String, String > > & getSamples

(

)

Get the batch.

loadSamples_()

void loadSamples_ ( )

private

Load the batch from the csv file and store as the vector of maps.

operator=()

FIAMSScheduler & operator= ( const FIAMSScheduler &  fdp )

default

Assignment.

run()

void run

(

)

Run the FIA-MS data analysis for the batch defined in the filename_.

Member Data Documentation

base_dir_

String base_dir_

private

filename_

String filename_

private

load_cached_

bool load_cached_

private

output_dir_

String output_dir_

private

samples_

std::vector<std::map<String, String> > samples_

private