MIRA
RPCCallDefinition.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) by
3  * MetraLabs GmbH (MLAB), GERMANY
4  * and
5  * Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
6  * All rights reserved.
7  *
8  * Contact: info@mira-project.org
9  *
10  * Commercial Usage:
11  * Licensees holding valid commercial licenses may use this file in
12  * accordance with the commercial license agreement provided with the
13  * software or, alternatively, in accordance with the terms contained in
14  * a written agreement between you and MLAB or NICR.
15  *
16  * GNU General Public License Usage:
17  * Alternatively, this file may be used under the terms of the GNU
18  * General Public License version 3.0 as published by the Free Software
19  * Foundation and appearing in the file LICENSE.GPL3 included in the
20  * packaging of this file. Please review the following information to
21  * ensure the GNU General Public License version 3.0 requirements will be
22  * met: http://www.gnu.org/copyleft/gpl.html.
23  * Alternatively you may (at your option) use any later version of the GNU
24  * General Public License if such license has been publicly approved by
25  * MLAB and NICR (or its successors, if any).
26  *
27  * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
28  * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
29  * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
30  * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
33  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
34  * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
35  * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
36  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
37  */
38 
47 #ifndef _MIRA_RPCCALLDEFINITION_H_
48 #define _MIRA_RPCCALLDEFINITION_H_
49 
50 #include <string>
51 
52 #include <serialization/adapters/std/vector>
53 
54 namespace mira {
55 
57 
63 {
65  RPCCallDefinition(const std::string& iService, const std::string& iMethod,
66  const std::string& iParams = "")
67  : service(iService), method(iMethod), params(iParams)
68  {
69  }
70 
71 public:
72 
73  template <typename Reflector>
74  void reflect(Reflector& r)
75  {
76  r.member("Service", service, "Service name");
77  r.member("Method", method, "Method name");
78  r.member("Params", params, "Parameter list as JSON array", "");
79  }
80 
82  std::string service;
83 
85  std::string method;
86 
88  std::string params;
89 };
90 
91 typedef std::vector<RPCCallDefinition> RPCCallDefinitions;
92 
94 
95 } // namespace
96 
97 #endif /* _MIRA_RPCCALLDEFINITION_H_ */
std::vector< RPCCallDefinition > RPCCallDefinitions
Definition: RPCCallDefinition.h:91
specialize cv::DataType for our ImgPixel and inherit from cv::DataType<Vec>
Definition: IOService.h:67
std::string method
The method&#39;s name.
Definition: RPCCallDefinition.h:85
RPCCallDefinition(const std::string &iService, const std::string &iMethod, const std::string &iParams="")
Definition: RPCCallDefinition.h:65
std::string params
The parameters as JSON array (note: without enclosing [])
Definition: RPCCallDefinition.h:88
void reflect(Reflector &r)
Definition: RPCCallDefinition.h:74
RPCCallDefinition()
Definition: RPCCallDefinition.h:64
std::string service
The service&#39;s name.
Definition: RPCCallDefinition.h:82
Stores info required to call an RPC method - service name, method name, arguments.
Definition: RPCCallDefinition.h:62