Gazebo Fuel_tools

API Reference

7.3.1
gz/fuel_tools/Interface.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2018 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16 */
17 
18 #ifndef GZ_FUEL_TOOLS_INTERFACE_HH_
19 #define GZ_FUEL_TOOLS_INTERFACE_HH_
20 
21 #include <string>
22 #include "gz/fuel_tools/Export.hh"
24 
25 namespace ignition
26 {
27  namespace fuel_tools
28  {
33  IGNITION_FUEL_TOOLS_VISIBLE std::string fetchResource(
34  const std::string &_uri);
35 
41  IGNITION_FUEL_TOOLS_VISIBLE std::string fetchResourceWithClient(
42  const std::string &_uri, gz::fuel_tools::FuelClient &_client);
43 
62  IGNITION_FUEL_TOOLS_VISIBLE std::string sdfFromPath(
63  const std::string &_path);
64  }
65 }
66 
67 #endif
STL class.
std::string fetchResourceWithClient(const std::string &_uri, FuelClient &_client)
Download the specified resource using the ClientConfig contained in the FuelClient parameter.
std::string fetchResource(const std::string &_uri)
Download the specified resource into the default configuration of fuel tools. This will place the ass...
std::string sdfFromPath(const std::string &_path)
Get the SDF file path for a model or world based on a directory containing a Fuel model or world....