EnzymeXMLDataProvider< EnzymeType > Class Template Reference

Data provider that loads digestion enzymes from an XML file. More...

#include <OpenMS/CHEMISTRY/EnzymeXMLDataProvider.h>

Inheritance diagram for EnzymeXMLDataProvider< EnzymeType >:

Collaboration diagram for EnzymeXMLDataProvider< EnzymeType >:

Public Member Functions
	EnzymeXMLDataProvider (const String &filename, bool optional=false)
	Construct a provider for the given enzyme XML file.
std::vector< std::unique_ptr< EnzymeType > >	loadEnzymes () override
	Parses enzyme definitions from the configured XML file.
Public Member Functions inherited from DigestionEnzymeDataProvider< EnzymeType >
virtual	~DigestionEnzymeDataProvider ()=default

Private Attributes
String	filename_
bool	optional_

Detailed Description

template<typename EnzymeType>
class OpenMS::EnzymeXMLDataProvider< EnzymeType >

Data provider that loads digestion enzymes from an XML file.

Parses enzyme definitions from a ParamXML-formatted file (e.g. Enzymes.xml, Enzymes_RNA.xml). The file is located via File::find().

Template parameter EnzymeType should be a subclass of DigestionEnzyme (e.g. DigestionEnzymeProtein, DigestionEnzymeRNA).

Constructor & Destructor Documentation

EnzymeXMLDataProvider()

template<typename EnzymeType >

EnzymeXMLDataProvider ( const String &  filename, bool  optional = false  )

explicit

Construct a provider for the given enzyme XML file.

Parameters

[in]	filename	Relative filename to locate via File::find() (e.g. "CHEMISTRY/Enzymes.xml")
[in]	optional	If true, return empty vector when file is not found instead of throwing

Member Function Documentation

loadEnzymes()

template<typename EnzymeType >

std::vector< std::unique_ptr< EnzymeType > > loadEnzymes ( )

overridevirtual

Parses enzyme definitions from the configured XML file.

Implements DigestionEnzymeDataProvider< EnzymeType >.

Member Data Documentation

filename_

template<typename EnzymeType >

String filename_

private

optional_

template<typename EnzymeType >

bool optional_

private