OpenMS::NuXLPresets Namespace Reference

Functions
StringList	getAllPresetsNames (const std::string &custom_presets_file="")
	Get all available presets names from JSON file.
void	getPresets (const std::string &p, const std::string &custom_presets_file, StringList &nucleotides, StringList &mapping, StringList &modifications, StringList &fragment_adducts, std::string &can_cross_link)
	Get preset parameters for a given preset name.
void	getPresets (const std::string &p, StringList &nucleotides, StringList &mapping, StringList &modifications, StringList &fragment_adducts, std::string &can_cross_link)
	Get preset parameters for a given preset name (using default presets file)

Function Documentation

getAllPresetsNames()

StringList getAllPresetsNames

(

const std::string &

custom_presets_file = ""

)

Get all available presets names from JSON file.

Parameters

[in]

custom_presets_file

Optional path to a custom presets file

Returns

StringList containing all available preset names

getPresets() [1/2]

void getPresets	(	const std::string &	p,
		const std::string &	custom_presets_file,
		StringList &	nucleotides,
		StringList &	mapping,
		StringList &	modifications,
		StringList &	fragment_adducts,
		std::string &	can_cross_link
	)

Get preset parameters for a given preset name.

Parameters

[in]	p	The preset name
[in]	custom_presets_file	Optional path to a custom presets file
[out]	nucleotides	Output parameter for nucleotides
[out]	mapping	Output parameter for mapping
[out]	modifications	Output parameter for modifications
[out]	fragment_adducts	Output parameter for fragment adducts
[out]	can_cross_link	Output parameter for can_cross_link

getPresets() [2/2]

void getPresets	(	const std::string &	p,
		StringList &	nucleotides,
		StringList &	mapping,
		StringList &	modifications,
		StringList &	fragment_adducts,
		std::string &	can_cross_link
	)

Get preset parameters for a given preset name (using default presets file)

Parameters

[in]	p	The preset name
[out]	nucleotides	Output parameter for nucleotides
[out]	mapping	Output parameter for mapping
[out]	modifications	Output parameter for modifications
[out]	fragment_adducts	Output parameter for fragment adducts
[out]	can_cross_link	Output parameter for can_cross_link