Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
ToolDescription.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2017.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Chris Bielow $
32 // $Authors: Chris Bielow, Mathias Walzer $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_DATASTRUCTURES_TOOLDESCRIPTION_H
36 #define OPENMS_DATASTRUCTURES_TOOLDESCRIPTION_H
37 
40 
41 #include <OpenMS/OpenMSConfig.h>
42 
43 #include <map>
44 
45 namespace OpenMS
46 {
47 
48  namespace Internal
49  {
54  struct FileMapping
55  {
56  String location; // a regex/macro mix; to be expanded by tool;
57  String target; // TOPP parameter that determines the desired name
58  // thus: move location -> target
59 
60  FileMapping& operator=(const FileMapping& rhs);
61  };
62 
67  struct MappingParam
68  {
69  std::map<Int, String> mapping;
70  std::vector<FileMapping> pre_moves;
71  std::vector<FileMapping> post_moves;
72 
73  OPENMS_DLLAPI MappingParam& operator=(const MappingParam& rhs);
74 
75  };
76 
84  struct OPENMS_DLLAPI ToolDescriptionInternal
85  {
89  StringList types; // -types of the tool (if any, e.g. ['centroided','wavelet'])
90 
91  // default C'Tor
93 
94  // C'Tor with arguments
95  ToolDescriptionInternal(const bool p_is_internal, const String& p_name, const String& p_category, const StringList& p_types);
96 
97  // short C'Tor
98  ToolDescriptionInternal(const String& p_name, const StringList& p_types);
99 
101 
102  bool operator==(const ToolDescriptionInternal& rhs) const;
103 
104  bool operator<(const ToolDescriptionInternal& rhs) const;
105  };
106 
107  struct OPENMS_DLLAPI ToolExternalDetails
108  {
114  String path; //< filename to external tool
115  String working_directory; //< folder where the command will be executed from
118  };
119 
123  struct OPENMS_DLLAPI ToolDescription :
125  {
126  // additional details for external tools (one entry for each 'type')
127  std::vector<ToolExternalDetails> external_details;
128 
129  // default CTor
130  ToolDescription();
131 
132  // C'Tor for internal TOPP tools
133  ToolDescription(const String& p_name, const String& p_category, const StringList& p_types = StringList());
134 
135  void addExternalType(const String& type, const ToolExternalDetails& details);
136 
137  void append(const ToolDescription& other);
138 
140  };
141 
142  } // namespace Internal
143 
144 } // namespace OPENMS
145 
146 #endif // OPENMS_DATASTRUCTURES_TOOLDESCRIPTION_H
std::vector< FileMapping > pre_moves
Definition: ToolDescription.h:70
A more convenient string class.
Definition: String.h:57
Definition: ToolDescription.h:107
MappingParam tr_table
Definition: ToolDescription.h:116
String path
Definition: ToolDescription.h:114
Filename mappings for all input/output files.
Definition: ToolDescription.h:67
String text_startup
Definition: ToolDescription.h:109
Definition: ToolDescription.h:123
String target
Definition: ToolDescription.h:57
bool operator==(_Iterator< _Val, _Ref, _Ptr > const &, _Iterator< _Val, _Ref, _Ptr > const &)
Definition: KDTree.h:806
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
String text_finish
Definition: ToolDescription.h:111
bool operator<(const MultiplexDeltaMasses &dm1, const MultiplexDeltaMasses &dm2)
String category
Definition: ToolDescription.h:112
Maps input/output files to filenames for the external program.
Definition: ToolDescription.h:54
String category
Definition: ToolDescription.h:88
FileMapping & operator=(const FileMapping &rhs)
ToolDescription Class.
Definition: ToolDescription.h:84
String location
Definition: ToolDescription.h:56
String working_directory
Definition: ToolDescription.h:115
StringList types
Definition: ToolDescription.h:89
std::map< Int, String > mapping
Definition: ToolDescription.h:69
String name
Definition: ToolDescription.h:87
std::vector< ToolExternalDetails > external_details
Definition: ToolDescription.h:127
std::vector< String > StringList
Vector of String.
Definition: ListUtils.h:74
Management and storage of parameters / INI files.
Definition: Param.h:75
Param param
Definition: ToolDescription.h:117
String text_fail
Definition: ToolDescription.h:110
String commandline
Definition: ToolDescription.h:113
bool is_internal
Definition: ToolDescription.h:86
std::vector< FileMapping > post_moves
Definition: ToolDescription.h:71

OpenMS / TOPP release 2.3.0 Documentation generated on Tue Jan 9 2018 18:22:04 using doxygen 1.8.13