MetaInfoInterfaceUtils Class Reference

Utilities operating on containers inheriting from MetaInfoInterface. More...

#include <OpenMS/METADATA/MetaInfoInterfaceUtils.h>

Public Member Functions
	MetaInfoInterfaceUtils ()=delete
	hide c'tors to avoid instantiation of utils class More...
	MetaInfoInterfaceUtils (const MetaInfoInterfaceUtils &)=delete
MetaInfoInterfaceUtils &	operator= (MetaInfoInterfaceUtils &)=delete

Static Public Member Functions
Methods to find key sets
template<typename T_In , typename T_Out >
static T_Out	findCommonMetaKeys (const typename T_In::const_iterator &it_start, const typename T_In::const_iterator &it_end, float min_frequency, typename Detail::MetaKeyGetter< typename T_In::value_type > getter=Detail::MetaKeyGetter< typename T_In::value_type >())
	Find keys in a collection of MetaInfoInterface objects which reach a certain frequency threshold. More...

Detailed Description

Utilities operating on containers inheriting from MetaInfoInterface.

Constructor & Destructor Documentation

MetaInfoInterfaceUtils() [1/2]

MetaInfoInterfaceUtils ( )

delete

hide c'tors to avoid instantiation of utils class

MetaInfoInterfaceUtils() [2/2]

MetaInfoInterfaceUtils ( const MetaInfoInterfaceUtils &  )

delete

Member Function Documentation

findCommonMetaKeys()

static T_Out findCommonMetaKeys ( const typename T_In::const_iterator &  it_start, const typename T_In::const_iterator &  it_end, float  min_frequency, typename Detail::MetaKeyGetter< typename T_In::value_type >  getter = Detail::MetaKeyGetter<typename T_In::value_type>()  )

inlinestatic

Find keys in a collection of MetaInfoInterface objects which reach a certain frequency threshold.

Searches the given iterator range for the keys of each element's MetaInfoInterface keys and returns those keys, which reach a certain frequency threshold. Common use cases are min_frequency = 0 (i.e. take any key which occurs) and min_frequency = 100 (i.e. take only keys which are common to all elements in the iterator range).

Template Parameters

T_In	Input container (e.g. std::vector or alike), containing objects which implement the MetaInfoInterface (i.e. support 'getKeys()')
T_Out	Output container of type T<String> (e.g. std::set<String>)

Parameters

it_start	Iterator pointing to the initial position to search. (note: this does not need to correspond to the beginning of the container)
it_end	Iterator pointing to the end final position to search.
min_frequency	Minimum required frequency (in percent). Must be between 0-100. Other values are corrected to the closest value allowed.
getter	Helper class, which has a getKeys() member, which can extract the keys for a given MetaInfoInterface-object; see MetaKeyGetter

Returns

Returns a vector/list/set of keys passing the frequency criterion.

operator=()

MetaInfoInterfaceUtils& operator= ( MetaInfoInterfaceUtils &  )

delete