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

#include <RegionSlice.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< RegionSlice >

Definition at line 70 of file RegionSlice.hpp.

Member Function Documentation

§ id()

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

Definition at line 72 of file RegionSlice.hpp.

72 {return "slice";}

§ description()

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

Definition at line 77 of file RegionSlice.hpp.

77 {return "write data from a rectangular region";}

§ argsFormat()

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

Definition at line 78 of file RegionSlice.hpp.

References SLICE_INDEX_ARG, SLICE_MZRANGE_ARG, SLICE_RETENTIONTIME_ARG, SLICE_SCAN_ARG, and TABULARCONFIG_DELIMITER_OPTIONS_STR.

78 {return "[" SLICE_MZRANGE_ARG "=<mzLow>[,<mzHigh>]] [" SLICE_RETENTIONTIME_ARG "=<rtLow>[,<rtHigh>]]] [" SLICE_INDEX_ARG "=<indexLow>[,<indexHigh>] | " SLICE_SCAN_ARG "=<scanLow>[,<scanHigh>]] [" TABULARCONFIG_DELIMITER_OPTIONS_STR "]";}
#define SLICE_INDEX_ARG
Definition: RegionSlice.hpp:73
#define SLICE_SCAN_ARG
Definition: RegionSlice.hpp:74
#define TABULARCONFIG_DELIMITER_OPTIONS_STR
#define SLICE_MZRANGE_ARG
Definition: RegionSlice.hpp:76
#define SLICE_RETENTIONTIME_ARG
Definition: RegionSlice.hpp:75

§ argsUsage()

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

Definition at line 79 of file RegionSlice.hpp.

References SLICE_INDEX_ARG, SLICE_MZRANGE_ARG, SLICE_RETENTIONTIME_ARG, SLICE_SCAN_ARG, and TABULARCONFIG_DELIMITER_USAGE_STR.

80  {
81  std::vector<std::string> result;
82  result.push_back(SLICE_MZRANGE_ARG": set m/z range");
83  result.push_back(SLICE_RETENTIONTIME_ARG": set retention time range");
84  result.push_back(SLICE_INDEX_ARG": set spectrum index range");
85  result.push_back(SLICE_SCAN_ARG": set scan number range");
86  result.push_back(TABULARCONFIG_DELIMITER_USAGE_STR);
87  return result;
88  }
#define SLICE_INDEX_ARG
Definition: RegionSlice.hpp:73
#define TABULARCONFIG_DELIMITER_USAGE_STR
#define SLICE_SCAN_ARG
Definition: RegionSlice.hpp:74
#define SLICE_MZRANGE_ARG
Definition: RegionSlice.hpp:76
#define SLICE_RETENTIONTIME_ARG
Definition: RegionSlice.hpp:75

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