ProteoWizard
Static Public Member Functions | List of all members
pwiz::analysis::analyzer_strings< analyzer_type > Struct Template Reference

This auxilliary class should be specialized for MSDataAnalyzers whose instantiation is controlled by user-supplied strings (via command line, config file, etc.). More...

#include <MSDataAnalyzer.hpp>

Static Public Member Functions

static const char * id ()
 string identifier for the analyzer
 
static const char * description ()
 description of the analyzer
 
static const char * argsFormat ()
 format of args string
 
static std::vector< std::string > argsUsage ()
 description of args string options
 

Detailed Description

template<typename analyzer_type>
struct pwiz::analysis::analyzer_strings< analyzer_type >

This auxilliary class should be specialized for MSDataAnalyzers whose instantiation is controlled by user-supplied strings (via command line, config file, etc.).

Definition at line 115 of file MSDataAnalyzer.hpp.

Member Function Documentation

◆ id()

template<typename analyzer_type >
static const char * pwiz::analysis::analyzer_strings< analyzer_type >::id ( )
inlinestatic

string identifier for the analyzer

Definition at line 118 of file MSDataAnalyzer.hpp.

118{return "analyzer_traits not specialized";}

◆ description()

template<typename analyzer_type >
static const char * pwiz::analysis::analyzer_strings< analyzer_type >::description ( )
inlinestatic

description of the analyzer

Definition at line 121 of file MSDataAnalyzer.hpp.

121{return typeid(analyzer_type).name();}

◆ argsFormat()

template<typename analyzer_type >
static const char * pwiz::analysis::analyzer_strings< analyzer_type >::argsFormat ( )
inlinestatic

format of args string

Definition at line 124 of file MSDataAnalyzer.hpp.

124{return "";}

◆ argsUsage()

template<typename analyzer_type >
static std::vector< std::string > pwiz::analysis::analyzer_strings< analyzer_type >::argsUsage ( )
inlinestatic

description of args string options

Definition at line 127 of file MSDataAnalyzer.hpp.

127{return std::vector<std::string>();}

The documentation for this struct was generated from the following file: