Exports .cwl files. More...

#include <OpenMS/FORMAT/ParamCWLFile.h>

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.

Static Public Member Functions
static bool	isSupported ()
	Whether this build can write CWL files.

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

◆ isSupported()

static bool isSupported ( )

static

Whether this build can write CWL files.

Writing CWL needs the TDL library, which is only linked when OpenMS is configured with ENABLE_TDL=ON (the default is OFF). Without it, store() and writeCWLToStream() throw.

◆ 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

Exception::NotImplemented	is thrown if this build has no CWL support (see isSupported()); no file is created then
Exception::UnableToCreateFile	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.

Exceptions

Exception::NotImplemented is thrown if this build has no CWL support (see isSupported())

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.

Public Member Functions

Static Public Member Functions