Matrix Science Mascot Parser toolkit
 
Loading...
Searching...
No Matches
ms_mascotoptions.hpp
1/*
2##############################################################################
3# file: ms_mascotoptions.hpp #
4# 'msparser' toolkit #
5# Encapsulates "Options" section of "mascot.dat" file that describes most #
6# important parameters #
7##############################################################################
8# COPYRIGHT NOTICE #
9# Copyright 1998-2003 Matrix Science Limited All Rights Reserved. #
10# #
11##############################################################################
12# $Archive:: /Mowse/ms_mascotresfile/include/ms_mascotoptions.hpp $ #
13# $Author: villek@matrixscience.com $ #
14# $Date: 2024-09-23 16:44:58 +0100 $ #
15# $Revision: 36c172aa7a374da00801ddc253b196c3974597d0 | MSPARSER_REL_3_0_0-2024-09-24-0-g93ebaeb4f4 $ #
16# $NoKeywords:: $ #
17##############################################################################
18*/
19
20#ifndef MS_MASCOTOPTIONS_HPP
21#define MS_MASCOTOPTIONS_HPP
22
23
24#include <string>
25#include <vector>
26
27namespace matrix_science {
32#ifndef DOXYGEN_SHOULD_SKIP_THIS
33 class MS_MASCOTRESFILE_API ms_blastaccession
34 {
35 friend class ms_datfile;
36
37 public:
38 ms_blastaccession();
39 ms_blastaccession(const ms_blastaccession& src);
40 ~ms_blastaccession();
41
42 void defaultValues();
43 void copyFrom(const ms_blastaccession* right);
44#ifndef SWIG
45 ms_blastaccession& operator=(const ms_blastaccession& right);
46#endif
47 bool isUseRegex() const;
48 void setUseRegex(const bool flag);
49
50 int getMinLength() const;
51 void setMinLength(const int value);
52
53 const char* getStart() const;
54 const char* getStop() const;
55
56 private:
57
58 bool useRegex_;
59 int minLen_;
60 char start_[255];
61 char stop_[255];
62 }; // class ms_blastaccession
63#endif
64
66
90 class MS_MASCOTRESFILE_API ms_mascotoptions: public ms_customproperty
91 {
92 friend class ms_datfile;
93
94 public:
96
100 {
101 MS_REVIEW_COL_JOB = 0x0000,
102 MS_REVIEW_COL_PID = 0x0001,
103 MS_REVIEW_COL_DATABASE = 0x0002,
104 MS_REVIEW_COL_USERNAME = 0x0003,
105 MS_REVIEW_COL_USEREMAIL = 0x0004,
106 MS_REVIEW_COL_TITLE = 0x0005,
107 MS_REVIEW_COL_RESULTS_FILE = 0x0006,
108 MS_REVIEW_COL_START_TIME = 0x0007,
109 MS_REVIEW_COL_DURATION = 0x0008,
110 MS_REVIEW_COL_STATUS = 0x0009,
111 MS_REVIEW_COL_PRIORITY = 0x000A,
112 MS_REVIEW_COL_SEARCHTYPE = 0x000B,
113 MS_REVIEW_COL_ENZYMEUSED = 0x000C,
114 MS_REVIEW_COL_IPADDRESS = 0x000D,
115 MS_REVIEW_COL_USERID = 0x000E,
116 MS_REVIEW_COL_PEAKLISTDATAFILE = 0x000F,
117 MS_REVIEW_COL____LAST___ = 0x0010
118 };
119
121
125 PERC_EXE_RT_USE_DEFAULT = 1,
126 PERC_EXE_RT_FORCE_ON = 2,
127 PERC_EXE_RT_FORCE_OFF = 3
128 };
129
131
157 DECOY_ALGORITHM_NONE = 0,
158 DECOY_PROTEIN_REVERSE = 1,
159 DECOY_PEPTIDE_REVERSE = 2,
160 DECOY_PROTEIN_RANDOM = 3,
161 DECOY_PEPTIDE_RANDOM = 4,
162 DECOY_PROTEIN_RANDOM_DIPEP = 5,
163 DECOY_PEPTIDE_RANDOM_DIPEP = 6,
164 DECOY_PROTEIN_SHUFFLE = 7,
165 DECOY_PEPTIDE_SHUFFLE = 8,
166
167 DECOY_PROTEIN_BASED_MASK = 0x0001
168 };
169
170
172
176 {
177 MAX_EXEC_AFTER_SEARCH = 10
178 };
179
180 enum REPORTBUILDER_COL_ARR
181 {
182 MAX_REPORTBUILDER_COL_ARR = 10
183 };
184
187 {
188 MASS_DECIMAL_PLACES = 6
189 };
190
193
196
199
201 void copyFrom(const ms_mascotoptions* right);
202
203#ifndef SWIG
205 ms_mascotoptions& operator=(const ms_mascotoptions& right);
206#endif
208 void defaultValues();
209
211 bool isSectionAvailable() const;
212
214 void setSectionAvailable(const bool value);
215
217 bool isSaveLastQueryAsc() const;
218
220 void setSaveLastQueryAsc(const bool flag);
221
223 bool isSaveEveryLastQueryAsc() const;
224
226 void setSaveEveryLastQueryAsc(const bool flag);
227
229 std::string getLastQueryAscFile() const;
230
232 void setLastQueryAscFile(const char* str);
233
235 std::string getErrorLogFile() const;
236
238 void setErrorLogFile(const char* str);
239
241 std::string getSearchLogFile() const;
242
244 void setSearchLogFile(const char* str);
245
247 std::string getMonitorLogFile() const;
248
250 void setMonitorLogFile(const char* str);
251
253 std::string getInterFileBasePath() const;
254
256 void setInterFileBasePath(const char* str);
257
259 std::string getInterFileRelPath() const;
260
262 void setInterFileRelPath(const char* str);
263
265 std::string getMascotCmdLine() const;
266
268 void setMascotCmdLine(const char* str);
269
271 std::string getTestDirectory() const;
272
274 void setTestDirectory(const char* str);
275
277 std::string getMascotControlFile() const;
278
280 void setMascotControlFile(const char* str);
281
283 std::string getMascNodeCtrlFile() const;
284
286 void setMascNodeCtrlFile(const char* str);
287
289 std::string getMascotJobIdFile() const;
290
292 void setMascotJobIdFile(const char* str);
293
295 std::string getGetSeqJobIdFile() const;
296
298 void setGetSeqJobIdFile(const char* str);
299
301 int getUniqueJobStartNumber() const;
302
304 void setUniqueJobStartNumber(const int value);
305
307 std::string getResultsPerlScript() const;
308
310 void setResultsPerlScript(const char* str);
311
313 std::string getNoResultsScript() const;
314
316 void setNoResultsScript(const char* str);
317
319 std::string getResultsFullURL() const;
320
322 void setResultsFullURL(const char* str);
323
325 std::string getLogoImageFile() const;
326
328 void setLogoImageFile(const char* str);
329
331 int getMassDecimalPlaces() const;
332
334 void setMassDecimalPlaces(const int value);
335
337 int getIonsDecimalPlaces() const;
338
340 void setIonsDecimalPlaces(const int value);
341
343 int getIntensitySigFigs() const;
344
346 void setIntensitySigFigs(const int value);
347
349 bool isEmailUsersEnabled() const;
350
352 void setEmailUsersEnabled(const bool value);
353
355 bool isEmailErrorsEnabled() const;
356
358 void setEmailErrorsEnabled(const bool value);
359
361 int getMailTransport() const;
362
364 void setMailTransport(const int value);
365
367 std::string getEmailService() const;
368
370 void setEmailService(const char* str);
371
373 std::string getEmailPassword() const;
374
376 void setEmailPassword(const char* str);
377
379 std::string getEmailProfile() const;
380
382 void setEmailProfile(const char* str);
383
385 std::string getSendmailPath() const;
386
388 void setSendmailPath(const char* str);
389
391 std::string getEmailFromUser() const;
392
394 void setEmailFromUser(const char* str);
395
397 std::string getEmailFromTextName() const;
398
400 void setEmailFromTextName(const char* str);
401
403 int getEmailTimeOutPeriod() const;
404
406 void setEmailTimeOutPeriod(const int value);
407
409 int getMonitorEmailCheckFreq() const;
410
412 void setMonitorEmailCheckFreq(const int value);
413
415 std::string getMailTempFile() const;
416
418 void setMailTempFile(const char* str);
419
421 std::string getErrMessageEmailTo() const;
422
424 void setErrMessageEmailTo(const char* str);
425
427 int getMonitorTestTimeout() const;
428
430 void setMonitorTestTimeout(const int value);
431
433 std::string getNTMonitorGroup() const;
434
436 void setNTMonitorGroup(const char* str);
437
439 std::string getNTIUserGroup() const;
440
442 void setNTIUserGroup(const char* str);
443
445 int getUnixWebUserGroup() const;
446
448 void setUnixWebUserGroup(const int value);
449
451 bool isForkForUnixApache() const;
452
454 void setForkForUnixApache(const bool value);
455
457 std::string getFormVersion() const;
458
460 void setFormVersion(const char* str);
461
463 int getMaxSequenceLen() const;
464
466 void setMaxSequenceLen(const int value);
467
469 int getMaxConcurrentSearches() const;
470
472 void setMaxConcurrentSearches(const int value);
473
475 int getMaxSearchesPerUser() const;
476
478 void setMaxSearchesPerUser(const int value);
479
481 double getCentroidWidth() const;
482
484 void setCentroidWidth(const double value);
485
487 int getCentroidWidthCount() const;
488
490 void setCentroidWidthCount(const int value);
491
493 int getMaxDescriptionLen() const;
494
496 void setMaxDescriptionLen(const int value);
497
499 int getMaxNumPeptides() const;
500
502 void setMaxNumPeptides(const int value);
503
505 INT64 getVmemory() const;
506
508 void setVmemory(const INT64 value);
509
511 int getNumberOfReportNumberChoices() const;
512
514 void clearReportNumberChoices();
515
517 int getReportNumberChoice(const int index) const;
518
520 void setReportNumberChoice(const int index, const int value);
521
523 void appendReportNumberChoice(const int value);
524
526 int getNumberOfTargetFDRPercentages() const;
527
529 void clearTargetFDRPercentages();
530
532 double getTargetFDRPercentage(const int index) const;
533
535 void setTargetFDRPercentage(const int index, const double value, const bool makeDefault = false);
536
538 void appendTargetFDRPercentage(const double value, const bool makeDefault = false);
539
541 bool isDefaultTargetFDRPercentage(const int index) const;
542
544 void setDefaultTargetFDRPercentage(const int index);
545
547 int getReviewColWidth(const MS_REVIEW_COL index) const;
548
550 void setReviewColWidth(const MS_REVIEW_COL index, const int value);
551
553 bool getReviewColDisplay(const MS_REVIEW_COL index) const;
554
556 void setReviewColDisplay(const MS_REVIEW_COL index, const bool value);
557
559 std::string getReportBuilderColumnArrangement(const int index) const;
560
562 int getMaxNumOfReportBuilderColumnArrangements() const;
563
565 void setReportBuilderColumnArrangement(const int index, const std::string str);
566
568 std::string getSpectrumViewerColourSchemeString(const std::string &name) const;
569
571 std::vector<std::string> getSpectrumViewerColourSchemeNames() const;
572
574 void setSpectrumViewerColourSchemeString(const std::string &name, const std::string &str, bool doCheck = true);
575
577 std::string getSpectrumViewerDefaultColourSchemeName() const;
578
580 void setSpectrumViewerDefaultColourSchemeName(const std::string &name);
581
583 std::string getProxyType() const;
584
586 void setProxyType(const std::string &value);
587
589 bool isUseHTTPProxyForFTP() const;
590
592 void setUseHTTPProxyForFTP(const bool value);
593
595 bool isUseHTTPProxyForHTTPS() const;
596
598 void setUseHTTPProxyForHTTPS(const bool value);
599
601 std::string getProxyServer() const;
602
604 void setProxyServer(const char* str);
605
607 std::string getProxyUsername() const;
608
610 void setProxyUsername(const char* str);
611
613 std::string getProxyPassword() const;
614
616 void setProxyPassword(const char* str);
617
619 int getMinPepLenInPepSummary() const;
620
622 void setMinPepLenInPepSummary(const int value);
623
625 int getMaxQueries() const;
626
628 void setMaxQueries(const int value);
629
631 bool isShowSubsets() const;
632
634 void setShowSubsets(const bool value);
635
637 double getShowSubsets() const;
638
640 void setShowSubsets(const double value);
641
643 bool isRequireBoldRed() const;
644
646 void setRequireBoldRed(const bool value);
647
649 double getSigThreshold() const;
650
652 void setSigThreshold(const double value);
653
655 double getSiteAnalysisMD10Prob() const;
656
658 void setSiteAnalysisMD10Prob(const double value);
659
661 int getMaxVarMods() const;
662
664 void setMaxVarMods(const int value);
665
667 int getMaxEtVarMods() const;
668
670 void setMaxEtVarMods(const int value);
671
673 int getErrTolMaxAccessions() const;
674
676 void setErrTolMaxAccessions(const int value);
677
679 bool isLabelAll() const;
680
682 void setLabelAll(const bool value);
683
685 bool isShowAllFromErrorTolerant() const;
686
688 void setShowAllFromErrorTolerant(const bool value);
689
691 double getIgnoreIonsScoreBelow() const;
692
694 void setIgnoreIonsScoreBelow(const double value);
695
697 std::string getMonitorPidFile() const;
698
700 void setMonitorPidFile(const char* str);
701
703 bool isStoreModPermutations() const;
704
706 void setStoreModPermutations(const bool value);
707
709 int getProteinsInResultsFile() const;
710
712 void setProteinsInResultsFile(const int value);
713
715 std::string getMascotMessage() const;
716
718 void setMascotMessage(const char* str);
719
721 int getSplitNumberOfQueries() const;
722
724 void setSplitNumberOfQueries(const int value);
725
727 int getSplitDataFileSize() const;
728
730 void setSplitDataFileSize(const int value);
731
733 bool isMoveOldDbToOldDir() const;
734
736 void setMoveOldDbToOldDir(const bool value);
737
739 bool isRemoveOldIndexFiles() const;
740
742 void setRemoveOldIndexFiles(const bool value);
743
745 int getFeatureTableLength() const;
746
748 void setFeatureTableLength(const int value);
749
751 double getFeatureTableMinScore() const;
752
754 void setFeatureTableMinScore(const double value);
755
757 std::string getICATLight() const;
758
760 void setICATLight(const char* modName);
761
763 std::string getICATHeavy() const;
764
766 void setICATHeavy(const char* modName);
767
769 std::string getICATFilter() const;
770
772 void setICATFilter(const char* filterString);
773
775 std::string getICATQuantitationMethod() const;
776
778 void setICATQuantitationMethod(const char* methodName);
779
781 unsigned int getNumberOfIgnoreDupeAccessions() const;
782
784 void clearIgnoreDupeAccessions();
785
787 std::string getIgnoreDupeAccession(const unsigned int index) const;
788
790 void setIgnoreDupeAccession(const unsigned int index, const std::string value);
791
793 void appendIgnoreDupeAccession(const std::string value);
794
796 bool isInIgnoreDupeAccessionList(const std::string value) const;
797
799 int getUnixDirPerm() const;
800
802 void setUnixDirPerm(const int value);
803
805 bool isUnixDirPermDefined() const;
806
808 int getMudpit() const;
809
811 void setMudpit(const int value);
812
814 double getPrecursorCutOutLowerLimit() const;
815
817 void setPrecursorCutOutLowerLimit(const double value);
818
820 double getPrecursorCutOutUpperLimit() const;
821
823 void setPrecursorCutOutUpperLimit(const double value);
824
826 bool isAutoSelectCharge() const;
827
829 void setAutoSelectCharge(const bool value);
830
832 std::string getTaxBrowserUrl() const;
833
835 void setTaxBrowserUrl(const std::string value);
836
838 int getMinPepLenInSearch() const;
839
841 void setMinPepLenInSearch(const int value);
842
844 int getMaxPepModArrangements() const;
845
847 void setMaxPepModArrangements(const int value);
848
850 int getMaxPepNumVarMods() const;
851
853 void setMaxPepNumVarMods(const int value);
854
856 int getMaxPepNumModifiedSites() const;
857
859 void setMaxPepNumModifiedSites(const int value);
860
862 bool isIteratePMFIntensities() const;
863
865 void setIteratePMFIntensities(const bool value);
866
868 double getMinEtagMassDelta() const;
869
871 void setMinEtagMassDelta(const double value);
872
874 double getMaxEtagMassDelta() const;
875
877 void setMaxEtagMassDelta(const double value);
878
880 std::string getResultsFileFormatVersion() const;
881
883 void setResultsFileFormatVersion(const char *value);
884
886 std::string getSortUnassigned() const;
887
889 void setSortUnassigned(const std::string newValue);
890
892 int getSelectSwitch() const;
893
895 void setSelectSwitch(const int value);
896
898 double getMudpitSwitch() const;
899
901 void setMudpitSwitch(const double value);
902
904 int getMaxDatabases() const;
905
907 void setMaxDatabases(const int value);
908
910 std::string getCacheDirectory() const;
911
913 void setCacheDirectory(const char * value);
914
916 std::string getResfileCache() const;
917
919 void setResfileCache(const char * value);
920
922 std::string getResultsCache() const;
923
925 void setResultsCache(const char * value);
926
928 bool isPercolator() const;
929
931 void setPercolator(const bool value);
932
934 std::string getPercolatorFeatures() const;
935
937 void setPercolatorFeatures(std::string value);
938
940 int getPercolatorMinQueries() const;
941
943 void setPercolatorMinQueries(const int value);
944
946 int getPercolatorMinSequences() const;
947
949 void setPercolatorMinSequences(const int value);
950
952 bool isPercolatorUseProteins() const;
953
955 void setPercolatorUseProteins(const bool value);
956
958 bool isPercolatorUseRT() const;
959
961 void setPercolatorUseRT(const bool value);
962
964 std::string getPercolatorExeFlags(bool anyRetentionTimes,
965 const std::vector<std::string> percolatorFiles,
966 const PERC_EXE_RT rt = PERC_EXE_RT_USE_DEFAULT) const;
967
969 void setPercolatorExeFlags(const char * value);
970
972 int getPercolatorTargetRankScoreThreshold() const;
973
975 void setPercolatorTargetRankScoreThreshold(const int threshold);
976
978 double getPercolatorTargetRankRelativeThreshold() const;
979
981 void setPercolatorTargetRankRelativeThreshold(const double threshold);
982
984 int getCreatePipThreads() const;
985
987 void setCreatePipThreads(const int nThreads);
988
990 int getCreatePipThreadBlockSize() const;
991
993 void setCreatePipThreadBlockSize(const int blockSize);
994
996 int getExecAfterSearch(const char * szResultsFilePath,
997 std::vector<std::string> & commands,
998 std::vector<std::string> & titles,
999 std::vector<int> & waitfor,
1000 std::vector<int> & logging,
1001 std::vector<std::string> & additionalFlags,
1002 const char * sessionID = 0,
1003 const char * taskID = 0) const;
1004
1006 void setExecAfterSearch(const int num, std::string value);
1007
1009 std::string getResultsPerlScript_2() const;
1010
1012 void setResultsPerlScript_2(std::string value);
1013
1015 std::string getResultsFullURL_2() const;
1016
1018 void setResultsFullURL_2(std::string value);
1019
1021 int getProteinFamilySwitch() const;
1022
1024 void setProteinFamilySwitch(const int value);
1025
1027 int getDecoyTypeSpecific() const;
1028
1030 void setDecoyTypeSpecific(const int value);
1031
1033 int getDecoyTypeNoEnzyme() const;
1034
1036 void setDecoyTypeNoEnzyme(const int value);
1037
1039 int getSVGSpectrumSwitch() const;
1040
1042 void setSVGSpectrumSwitch(const int value);
1043
1045 int getDisplayNonSignificantMatches() const;
1046
1048 void setDisplayNonSignificantMatches(const int value);
1049
1051 std::string getCompressToolAA() const;
1052
1054 void setCompressToolAA(const std::string value);
1055
1057 std::string getCompressToolNA() const;
1058
1060 void setCompressToolNA(const std::string value);
1061
1063 std::string getCompressToolSL() const;
1064
1066 void setCompressToolSL(const std::string value);
1067
1069 std::string getCompressToolCommandLineFasta(DATABASE_TYPE dbType,
1070 const std::string & dbname,
1071 const std::string & dbpath) const;
1072
1074 std::string getCompressToolCommandLineLibrary(const std::string & logfilepath,
1075 const std::string & inputfile,
1076 const std::string & outputdirectory) const;
1077
1079 std::string getPepSearchTool() const;
1080
1082 void setPepSearchTool(const std::string value);
1083
1085 std::string getPepSearchToolCommandLine(const std::string & peptideToleranceUnit,
1086 const double & peptideTolerance,
1087 const std::string & ionToleranceUnit,
1088 const double & ionTolerance,
1089 const std::string & libraryDirectoryPath,
1090 const std::string & inputFileRelativePath,
1091 const std::string & outputFileRelativePath) const;
1092
1094 int getSpectraPerLibraryBlock() const;
1095
1097 void setSpectraPerLibraryBlock(const int value);
1098
1100 int getCrawlerNumPeaksPer100Da() const;
1101
1103 void setCrawlerNumPeaksPer100Da(const int value);
1104
1106 std::string getSearchSubmitMode() const;
1107
1109 void setSearchSubmitMode(const std::string value);
1110
1112 int getDechargeFragmentPeaks() const;
1113
1115 void setDechargeFragmentPeaks(const int maxCharge);
1116
1118 std::string getSearchSubmitOutputFormat() const;
1119
1121 void setSearchSubmitOutputFormat(const std::string value);
1122
1124 bool isAlwaysCreateDat28ResultsFile() const;
1125
1127 void setAlwaysCreateDat28ResultsFile(const bool value);
1128
1130 bool isCreateLegacyModAndSubstitutionFiles() const;
1131
1133 void setCreateLegacyModAndSubstitutionFiles(const bool value);
1134
1136 bool isAlwaysEnableAutoDecoySearch() const;
1137
1139 void setAlwaysEnableAutoDecoySearch(const bool value);
1140
1142 std::string getSearchSubmitAcceptedFileTypes() const;
1143
1145 void setSearchSubmitAcceptedFileTypes(const std::string value);
1146
1148 std::string getSearchSubmitDefaultPeptideCharge() const;
1149
1151 void setSearchSubmitDefaultPeptideCharge(const std::string value);
1152
1154
1156 const ms_blastaccession* getGetSeqBlastAccession() const;
1157
1159 void setGetSeqBlastAccession(const ms_blastaccession* value);
1160
1161 // MatrixScience internal usage only
1162 int getMinPeakIteration() const;
1163
1164 // MatrixScience internal usage only
1165 void setMinPeakIteration(const int value);
1166
1167 // MatrixScience internal usage only
1168 bool isEncryptURL() const;
1169
1170 // MatrixScience internal usage only
1171 void setEncryptURL(const bool value);
1172
1173 // MatrixScience internal usage only
1174 std::string getPercolatorExeFlags() const;
1175
1177 std::string getPercolatorRtFlags(const bool anyRetentionTimes, const bool useRT) const;
1178
1179 // MatrixScience internal usage only
1180 std::string getExecAfterSearch(const int num) const;
1181
1182 // MatrixScience internal usage only
1183 void checkExecAfterSearch(ms_errs & err);
1184
1185 // MatrixScience internal usage only
1186 void checkReportBuilderColumnArrangement(ms_errs & err);
1187
1188 // MatrixScience internal usage only
1189 void checkSpectrumViewerColourSchemes(ms_errs & err, bool addToList = true);
1190
1192 bool isMatchOppositeCrosslinkPairs() const;
1193
1195 void setMatchOppositeCrosslinkPairs(const bool value);
1196
1198 int getMaxIntactCrosslinkPeptides() const;
1199
1201 void setMaxIntactCrosslinkPeptides(const int value);
1202
1204 bool isTransferParsingToNodes() const;
1205
1207 void setTransferParsingToNodes(const bool value);
1208
1210 int getMascotFileProcessingThreads() const;
1211
1213 void setMascotFileProcessingThreads(const int value);
1214
1216 int getInputFileParsingThreads() const;
1217
1219 void setInputFileParsingThreads(const int value);
1220
1222 int getChunkReadingThreads() const;
1223
1225 void setChunkReadingThreads(const int value);
1226
1228 int getChunkPreparationThreads() const;
1229
1231 void setChunkPreparationThreads(const int value);
1232
1234 bool isMsrSqlQueriesInTransactions() const;
1235
1237 void setMsrSqlQueriesInTransactions(const bool value);
1238
1240 bool getAllowEmbeddedConfigInMimeInput() const;
1241
1243 void setAllowEmbeddedConfigInMimeInput(const bool value);
1244
1245
1246#ifdef SUPPRESS_MS_CUSTOMPROPERTY_INHERITANCE
1247#include "suppress_ms_customproperty.hpp"
1248#endif
1249
1250 private:
1251 void synchronizeReportNumberChoices_();
1252 void synchronizeIgnoreDupeAccession_();
1253 void synchronizeTargetFDRPercentages_();
1254
1255 bool sectionAvailable_;
1256
1257 bool saveLastQueryAsc_;
1258 bool saveEveryLastQueryAsc_;
1259 std::string lastQueryAscFile_;
1260
1261 std::string errorLogFile_;
1262 std::string searchLogFile_;
1263 std::string monitorLogFile_;
1264 std::string interFileBasePath_;
1265 std::string interFileRelPath_;
1266
1267 std::string mascotCmdLine_;
1268 std::string testDirectory_;
1269 std::string mascotControlFile_;
1270 std::string mascNodeCtrlFile_;
1271 std::string mascotJobIdFile_;
1272 std::string getSeqJobIdFile_;
1273 int uniqueJobStartNumber_;
1274
1275 std::string resultsPerlScript_;
1276 std::string noResultsScript_;
1277 std::string resultsFullURL_;
1278 std::string logoImageFile_;
1279
1280 int massDecimalPlaces_;
1281 int ionsDecimalPlaces_;
1282 int intensitySigFigs_;
1283
1284 bool emailUsersEnabled_;
1285 bool emailErrorsEnabled_;
1286 int mailTransport_;
1287 std::string emailService_;
1288 std::string emailPassword_;
1289 std::string emailProfile_;
1290 std::string sendmailPath_;
1291 std::string emailFromUser_;
1292 std::string emailFromTextName_;
1293 int emailTimeOutPeriod_;
1294 int monitorEmailCheckFreq_;
1295 std::string mailTempFile_;
1296 std::string errMessageEmailTo_;
1297
1298 int monitorTestTimeout_;
1299 std::string NTMonitorGroup_;
1300 std::string NTIUserGroup_;
1301 int unixWebUserGroup_;
1302 bool forkForUnixApache_;
1303
1304 std::string formVersion_;
1305 int maxSequenceLen_;
1306 int maxConcurrentSearches_;
1307 int maxSearchesPerUser_;
1308 double centroidWidth_;
1309 int centroidWidthCount_;
1310 int maxDescriptionLen_;
1311 int maxNumPeptides_;
1312 INT64 vmemory_;
1313
1314 std::vector< int > reportNumberChoices_;
1315 std::vector< double > targetFDRPercentages_;
1316 int defaultTargetFDRPercentagesIx_;
1317
1318 int reviewColWidths_[MS_REVIEW_COL____LAST___];
1319 bool reviewColDisplay_[MS_REVIEW_COL____LAST___];
1320 std::vector<std::string> reportBuilderColArr_;
1321
1322 std::string defaultColourSchemeName_;
1323 std::vector<std::string> colourSchemeNames_;
1324 std::vector<std::string> colourSchemeStrings_;
1325
1326 std::string proxyType_;
1327 bool useHTTPProxyForFTP_;
1328 bool useHTTPProxyForHTTPS_;
1329 std::string proxy_server_;
1330 std::string proxy_username_;
1331 std::string proxy_password_;
1332
1333 int maxVarMods_;
1334 int maxEtVarMods_;
1335 int errTolMaxAccessions_;
1336 bool labelAll_;
1337 bool showAllFromErrorTolerant_;
1338
1339 int minPepLenInPepSummary_;
1340 int maxPepModArrangements_;
1341 int maxPepNumVarMods_;
1342 int maxPepNumModifiedSites_;
1343 int maxQueries_;
1344 double showSubsets_;
1345 bool requireBoldRed_;
1346 double sigThreshold_;
1347 double siteAnalysisMD10Prob_;
1348 double ignoreIonsScoreBelow_;
1349
1350 std::string monitorPidFile_;
1351 bool storeModPermutations_;
1352 int proteinsInResultsFile_;
1353 std::string mascotMessage_;
1354 int splitNumberOfQueries_;
1355 int splitDataFileSize_;
1356 bool moveOldDbToOldDir_;
1357 bool removeOldIndexFiles_;
1358
1359 int featureTableLength_;
1360 double featureTableMinScore_;
1361
1362 std::string ICATLight_;
1363 std::string ICATHeavy_;
1364 std::string ICATFilter_;
1365 std::string ICATQuantitationMethod_;
1366
1367 int UnixDirPerm_;
1368 bool UnixDirPermDefined_;
1369 int mudpit_;
1370
1371 typedef std::vector<std::string> t_dupeAccs;
1372 t_dupeAccs ignoreDupeAccessions_;
1373
1374 double precursorCutOutLowerLimit_;
1375 double precursorCutOutUpperLimit_;
1376
1377 bool autoSelectCharge_;
1378 std::string taxBrowserUrl_;
1379 int minPepLenInSearch_;
1380 bool iteratePMFIntensities_;
1381
1382 double minEtagMassDelta_;
1383 double maxEtagMassDelta_;
1384
1385 std::string resultsFileFormatVersion_;
1386 std::string sortUnassigned_;
1387 int selectSwitch_;
1388 double mudpitSwitch_;
1389
1390 int maxDatabases_;
1391 std::string cacheDirectory_;
1392
1393 std::string resfileCache_;
1394 std::string resultsCache_;
1395
1396 bool percolator_;
1397 std::string percolatorFeatures_;
1398 int percolatorMinQueries_;
1399 int percolatorMinSequences_;
1400 bool percolatorUseProteins_;
1401 bool percolatorUseRT_;
1402 std::string percolatorExeFlags_;
1403 int percolatorTargetRankScoreThreshold_;
1404 double percolatorTargetRankRelativeThreshold_;
1405
1406 int createPipThreads_;
1407 int createPipThreadBlockSize_;
1408
1409 std::vector<std::string> execAfterSearch_;
1410 std::vector<std::string> execAfterSearchCommands_;
1411 std::vector<std::string> execAfterSearchTitles_;
1412 std::vector<int> execAfterSearchWaitFor_;
1413 std::vector<int> execAfterSearchLogging_;
1414 std::vector<std::string> execAfterSearchAdditionalFlags_;
1415 std::string resultsPerlScript_2_;
1416 std::string resultsFullURL_2_;
1417 int proteinFamilySwitch_;
1418
1419 int decoyTypeSpecific_;
1420 int decoyTypeNoEnzyme_;
1421
1422 int svgSpectrumSwitch_;
1423 int displayNonSigMatches_;
1424
1425 ms_blastaccession getSeqBlastAccession_;
1426 int minPeakIteration_;
1427 bool encryptURL_;
1428
1429 std::string compressToolAA_;
1430 std::string compressToolNA_;
1431 std::string compressToolSL_;
1432 std::string pepSearchTool_;
1433 int spectraPerLibraryBlock_;
1434 int crawlerNumPeaksPer100Da_;
1435 bool matchOppositeCrosslinkPairs_;
1436 int maxIntactCrosslinkPeptides_;
1437 std::string searchSubmitMode_;
1438 int dechargeFragmentPeaks_;
1439 std::string searchSubmitOutputFormat_;
1440 bool alwaysCreateDat28ResultsFile_;
1441 bool transferParsingToNodes_; //internal Mascot debug option
1442 int mascotFileProcessingThreads_;
1443 int inputFileParsingThreads_; //internal Mascot debug option
1444 int chunkReadingThreads_; //internal Mascot debug option
1445 int chunkPreparationThreads_; //internal Mascot debug option
1446 bool msrSqlQueriesInTransactions_; //internal Mascot debug option
1447 bool allowEmbeddedConfigInMimeInput_; //internal
1448 bool createLegacyModAndSubstitutionFiles_; // Enable/disable creation of ../config/mod_file and ../config/substitutions
1449 bool alwaysEnableAutoDecoySearch_; // Enable/disable auto-decoy search
1450 std::string searchSubmitAcceptedFileTypes_; // Comma-separated list of input file types
1451 std::string searchSubmitDefaultPeptideCharge_; // e.g. "2+, 3+ and 4+"
1452 }; // class ms_mascotoptions // end of config_group
1454} // namespace matrix_science
1455
1456#endif // MS_MASCOTOPTIONS_HPP
1457
1458/*------------------------------- End of File -------------------------------*/
The class is used as a base for property-containing classes, such as ms_mascotoptions.
Definition: ms_customproperty.hpp:91
Encapsulates the mascot.dat file that contains the most important parameters.
Definition: ms_datfile.hpp:47
All errors are collected in an instance of this class.
Definition: ms_errors.hpp:37
An instance of this class represents all the parameters specified in the Options section of mascot....
Definition: ms_mascotoptions.hpp:91
PERC_EXE_RT
Definitions for retention time override when calling getPercolatorExeFlags().
Definition: ms_mascotoptions.hpp:124
EXEC_AFTER_SEARCH
Definitions for the ExecAfterSearch_XXX lines in the Options section of mascot.dat.
Definition: ms_mascotoptions.hpp:176
NUMERICAL_VALUE_STORAGE
Definitions for storage of numerical values in files.
Definition: ms_mascotoptions.hpp:187
MS_REVIEW_COL
Definitions for columns in ms-review.exe for use with getReviewColWidth() and getReviewColDisplay().
Definition: ms_mascotoptions.hpp:100
DECOY_ALGORITHM
Definitions for how the decoy sequences are generated.
Definition: ms_mascotoptions.hpp:156
DATABASE_TYPE
Definition: ms_databaseoptions.hpp:39