File adapter for ToolDescriptor files. More...

#include <OpenMS/FORMAT/ToolDescriptionFile.h>

Inheritance diagram for ToolDescriptionFile:

Collaboration diagram for ToolDescriptionFile:

Public Member Functions
	ToolDescriptionFile ()
	Default constructor.

	~ToolDescriptionFile () override
	Destructor.

void	load (const std::string &filename, std::vector< Internal::ToolDescription > &tds)
	Loads a map from a ToolDescriptor file.

void	store (const std::string &filename, const std::vector< Internal::ToolDescription > &tds) const
	Stores a map in a ToolDescriptor file.

Public Member Functions inherited from XMLFile
	XMLFile ()
	Construct an XMLFile without schema info; `schema_location_` remains unset, so isValid cannot be used until derived-class logic initializes `schema_location_` before calling isValid.

	XMLFile (const std::string &schema_location, const std::string &version)
	Construct with a schema location for later isValid calls.

virtual	~XMLFile ()
	Virtual destructor — defaulted; allows safe deletion through a base-class pointer.

bool	isValid (const std::string &filename, std::ostream &os)
	Check if `filename` validates against the bound XML schema.

const std::string &	getVersion () const
	Return the schema version string passed to the parameterised constructor; empty for default-constructed instances.

Public Member Functions inherited from ProgressLogger
	ProgressLogger ()
	Constructor.

virtual	~ProgressLogger ()
	Destructor.

	ProgressLogger (const ProgressLogger &other)
	Copy constructor.

ProgressLogger &	operator= (const ProgressLogger &other)
	Assignment Operator.

void	setLogType (LogType type) const
	Sets the progress log that should be used. The default type is NONE!

LogType	getLogType () const
	Returns the type of progress log being used.

void	setLogger (ProgressLoggerImpl *logger)
	Sets the logger to be used for progress logging.

void	startProgress (SignedSize begin, SignedSize end, const std::string &label) const
	Initializes the progress display.

void	setProgress (SignedSize value) const
	Sets the current progress.

void	endProgress (UInt64 bytes_processed=0) const

void	nextProgress () const
	increment progress by 1 (according to range begin-end)

Additional Inherited Members
Public Types inherited from ProgressLogger
enum	LogType { CMD , GUI , NONE }
	Possible log types. More...

Protected Member Functions inherited from XMLFile
void	parse_ (const std::string &filename, XMLHandler *handler)
	Parse the XML file at `filename` through `handler`.

void	parseBuffer_ (const std::string &buffer, XMLHandler *handler)
	Parse an in-memory XML buffer through `handler`.

void	save_ (const std::string &filename, XMLHandler *handler) const
	Stores the contents of the XML handler given by `handler` in the file given by `filename`.

void	enforceEncoding_ (const std::string &encoding)
	Set or clear the XML-encoding override applied to subsequent parse_ / parseBuffer_ calls.

Protected Attributes inherited from XMLFile
std::string	schema_location_
	Path of the XML schema for validation; empty when the default constructor was used (isValid then throws `NotImplemented`).

std::string	schema_version_
	Schema version string returned by getVersion.

std::string	enforced_encoding_
	Optional XML encoding override applied to the `InputSource` in parse_ and parseBuffer_; empty disables the override. Used as a workaround for XTandem output XML which carries an encoding the parser otherwise stumbles on.

Protected Attributes inherited from ProgressLogger
LogType	type_

time_t	last_invoke_

ProgressLoggerImpl *	current_logger_

Static Protected Attributes inherited from ProgressLogger
static int	recursion_depth_

Detailed Description

File adapter for ToolDescriptor files.

If a critical error occurs due to the missing functionality, Exception::NotImplemented is thrown.

Constructor & Destructor Documentation

◆ ToolDescriptionFile()

ToolDescriptionFile ( )

Default constructor.

◆ ~ToolDescriptionFile()

~ToolDescriptionFile ( )

override

Destructor.

Member Function Documentation

◆ load()

void load	(	const std::string &	filename,
		std::vector< Internal::ToolDescription > &	tds
	)

Loads a map from a ToolDescriptor file.

Exceptions

Exception::FileNotFound	is thrown if the file could not be opened
Exception::ParseError	is thrown if an error occurs during parsing

◆ store()

void store	(	const std::string &	filename,
		const std::vector< Internal::ToolDescription > &	tds
	)		const

Stores a map in a ToolDescriptor file.