ParamCWLFile Class Reference

Exports .cwl files. More...

#include <OpenMS/FORMAT/ParamCWLFile.h>

Collaboration diagram for ParamCWLFile:

Public Member Functions
void	store (const std::string &filename, const Param &param, const ToolInfo &tool_info) const
	Write CWL file.
void	writeCWLToStream (std::ostream *os_ptr, const Param &param, const ToolInfo &tool_info) const
	Write CWL to output stream.

Public Attributes
bool	flatHierarchy {}
	If set to true, all parameters will be listed without nesting when writing the CWL File. The names will be expanded to include the nesting hierarchy.

Detailed Description

Exports .cwl files.

  If Names include ':' it will be replaced with "__";

Member Function Documentation

store()

void store	(	const std::string &	filename,
		const Param &	param,
		const ToolInfo &	tool_info
	)		const

Write CWL file.

Parameters

[out]	filename	The name of the file the param data structure should be stored in.
[in]	param	The param data structure that should be stored.
[out]	tool_info	Additional information about the Tool for which the param data should be stored.

Exceptions

std::ios::failure

is thrown if the file could not be created

writeCWLToStream()

void writeCWLToStream	(	std::ostream *	os_ptr,
		const Param &	param,
		const ToolInfo &	tool_info
	)		const

Write CWL to output stream.

Parameters

[out]	os_ptr	The stream to which the param data should be written.
[out]	param	The param data structure that should be writte to stream.
[out]	tool_info	Additional information about the Tool for which the param data should be written.

Member Data Documentation

flatHierarchy

bool flatHierarchy {}

If set to true, all parameters will be listed without nesting when writing the CWL File. The names will be expanded to include the nesting hierarchy.