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

#include <RegionSIC.hpp>

Static Public Member Functions

static const char * id ()
 
static const char * description ()
 
static const char * argsFormat ()
 
static std::vector< std::string > argsUsage ()
 

Detailed Description

template<>
struct pwiz::analysis::analyzer_strings< RegionSIC >

Definition at line 85 of file RegionSIC.hpp.

Member Function Documentation

§ id()

static const char* pwiz::analysis::analyzer_strings< RegionSIC >::id ( )
inlinestatic

Definition at line 87 of file RegionSIC.hpp.

87 {return "sic";}

§ description()

static const char* pwiz::analysis::analyzer_strings< RegionSIC >::description ( )
inlinestatic

Definition at line 88 of file RegionSIC.hpp.

88 {return "write selected ion chromatogram for an m/z and radius";}

§ argsFormat()

static const char* pwiz::analysis::analyzer_strings< RegionSIC >::argsFormat ( )
inlinestatic

Definition at line 92 of file RegionSIC.hpp.

References SIC_MZCENTER_ARG, SIC_RADIUS_ARG, SIC_RADIUSUNITS_ARG, and TABULARCONFIG_DELIMITER_OPTIONS_STR.

92 {return SIC_MZCENTER_ARG "=<mz> " SIC_RADIUS_ARG"=<radius> " SIC_RADIUSUNITS_ARG "=<amu|ppm> [" TABULARCONFIG_DELIMITER_OPTIONS_STR "]";}
#define SIC_RADIUS_ARG
Definition: RegionSIC.hpp:90
#define SIC_MZCENTER_ARG
Definition: RegionSIC.hpp:89
#define TABULARCONFIG_DELIMITER_OPTIONS_STR
#define SIC_RADIUSUNITS_ARG
Definition: RegionSIC.hpp:91

§ argsUsage()

static std::vector<std::string> pwiz::analysis::analyzer_strings< RegionSIC >::argsUsage ( )
inlinestatic

Definition at line 93 of file RegionSIC.hpp.

References SIC_MZCENTER_ARG, SIC_RADIUS_ARG, SIC_RADIUSUNITS_ARG, and TABULARCONFIG_DELIMITER_USAGE_STR.

94  {
95  std::vector<std::string> usage;
96  usage.push_back(SIC_MZCENTER_ARG": set mz value");
97  usage.push_back(SIC_RADIUS_ARG": set radius value");
98  usage.push_back(SIC_RADIUSUNITS_ARG": set units for radius value (must be amu or ppm)");
99  usage.push_back(TABULARCONFIG_DELIMITER_USAGE_STR);
100  return usage;
101  }
#define SIC_RADIUS_ARG
Definition: RegionSIC.hpp:90
#define TABULARCONFIG_DELIMITER_USAGE_STR
#define SIC_MZCENTER_ARG
Definition: RegionSIC.hpp:89
#define SIC_RADIUSUNITS_ARG
Definition: RegionSIC.hpp:91

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