master.h
Go to the documentation of this file.
1 #include "sick_scan/sick_scan_base.h" /* Base definitions included in all header files, added by add_sick_scan_base_header.py. Do not edit this line. */
2 /*
3  * Copyright (C) 2009, Willow Garage, Inc.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  * * Redistributions of source code must retain the above copyright notice,
8  * this list of conditions and the following disclaimer.
9  * * Redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in the
11  * documentation and/or other materials provided with the distribution.
12  * * Neither the names of Stanford University or Willow Garage, Inc. nor the names of its
13  * contributors may be used to endorse or promote products derived from
14  * this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  * POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 #ifndef ROSCPP_MASTER_H
30 #define ROSCPP_MASTER_H
31 
32 #include "forwards.h"
33 #include "xmlrpcpp/XmlRpcValue.h"
34 #include "common.h"
35 
36 namespace roswrap
37 {
38 
42 namespace master
43 {
44 
55 ROSCPP_DECL bool execute(const std::string& method, const XmlRpc::XmlRpcValue& request, XmlRpc::XmlRpcValue& response, XmlRpc::XmlRpcValue& payload, bool wait_for_master);
56 
61 ROSCPP_DECL const std::string& getHost();
66 ROSCPP_DECL uint32_t getPort();
70 ROSCPP_DECL const std::string& getURI();
71 
81 ROSCPP_DECL bool check();
82 
87 {
88  TopicInfo() {}
89  TopicInfo(const std::string& _name, const std::string& _datatype /*, const std::string& _md5sum*/)
90  : name(_name)
91  , datatype(_datatype)
92  //, md5sum(_md5sum)
93  {}
94  std::string name;
95  std::string datatype;
96 
97  // not possible yet unfortunately (master does not have this information)
98  //std::string md5sum; ///< md5sum of the topic
99 };
100 typedef std::vector<TopicInfo> V_TopicInfo;
101 
114 ROSCPP_DECL bool getTopics(V_TopicInfo& topics);
115 
119 ROSCPP_DECL bool getNodes(V_string& nodes);
120 
126 
127 } // namespace master
128 
129 } // namespace roswrap
130 
131 #endif
response
const std::string response
roswrap::master::check
ROSCPP_DECL bool check()
Check whether the master is up.
roswrap::master::V_TopicInfo
std::vector< TopicInfo > V_TopicInfo
Definition: master.h:100
roswrap::master::getNodes
ROSCPP_DECL bool getNodes(V_string &nodes)
Retreives the currently-known list of nodes from the master.
forwards.h
roswrap::message_traits::datatype
const char * datatype()
returns DataType<M>::value();
Definition: message_traits.h:236
roswrap::master::execute
ROSCPP_DECL bool execute(const std::string &method, const XmlRpc::XmlRpcValue &request, XmlRpc::XmlRpcValue &response, XmlRpc::XmlRpcValue &payload, bool wait_for_master)
Execute an XMLRPC call on the master.
roswrap::master::TopicInfo::TopicInfo
TopicInfo(const std::string &_name, const std::string &_datatype)
Definition: master.h:89
roswrap::master::TopicInfo::TopicInfo
TopicInfo()
Definition: master.h:88
roswrap::master::TopicInfo::name
std::string name
Name of the topic.
Definition: master.h:94
pcap_json_converter.payload
string payload
Definition: pcap_json_converter.py:130
api.setup.name
name
Definition: python/api/setup.py:12
roswrap::master::setRetryTimeout
ROSCPP_DECL void setRetryTimeout(ros::WallDuration timeout)
Set the max time this node should spend looping trying to connect to the master.
roswrap::master::getURI
const ROSCPP_DECL std::string & getURI()
Get the full URI to the master (eg. http://host:port/)
roswrap
Definition: param_modi.cpp:41
roswrap::master::TopicInfo::datatype
std::string datatype
Datatype of the topic.
Definition: master.h:95
common.h
roswrap::master::getTopics
ROSCPP_DECL bool getTopics(V_TopicInfo &topics)
Get the list of topics that are being published by all nodes.
roswrap::master::TopicInfo
Contains information retrieved from the master about a topic.
Definition: master.h:86
roswrap::master::getPort
ROSCPP_DECL uint32_t getPort()
Get the port where the master runs.
sick_scan_base.h
sick_generic_device_finder.timeout
timeout
Definition: sick_generic_device_finder.py:113
roswrap::master::getHost
const ROSCPP_DECL std::string & getHost()
Get the hostname where the master runs.
ros::WallDuration
ROSCPP_DECL
#define ROSCPP_DECL
Definition: roswrap/src/cfgsimu/sick_scan/ros/common.h:63
XmlRpc::XmlRpcValue
RPC method arguments and results are represented by Values.
Definition: XmlRpcValue.h:25
roswrap::V_string
std::vector< std::string > V_string
Definition: datatypes.h:44


sick_scan_xd
Author(s): Michael Lehning , Jochen Sprickerhof , Martin Günther
autogenerated on Fri Oct 25 2024 02:47:09